Menu
GETPOST forms/{short_code}/mappings/ User APIService tier

Spec §4.2 list + §4.3 create.

URL

  • User APIhttps://forms.mattering.io/api/user/v1/forms/{short_code}/mappings/
  • Service tierhttps://forms.mattering.io/api/internal/forms/{short_code}/mappings/

Path parameters

NameType
short_codestr

Body keys (JSON)

KeyRequiredDefault
field_mapoptional or conditionalnone
include_all_answersoptional or conditionalnone
is_activeoptional or conditionalnone
static_valuesoptional or conditionalnone
targetoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 bare JSON object (no envelope)

{
  "mappings": [
    {
      "id": "...",
      "kind": "...",
      "target": "...",
      "node_type": "...",
      "connector_slug": "...",
      "instance_id": "...",
      "is_active": true,
      "target_space_id": "...",
      "target_project_id": "...",
      "target_widget_id": "...",
      "field_map": "...",
      "static_values": "...",
      "include_all_answers": "...",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ]
}

201 bare JSON object (no envelope)

{
  "mapping": {
    "id": "...",
    "kind": "...",
    "target": "...",
    "node_type": "...",
    "connector_slug": "...",
    "instance_id": "...",
    "is_active": true,
    "target_space_id": "...",
    "target_project_id": "...",
    "target_widget_id": "...",
    "field_map": "...",
    "static_values": "...",
    "include_all_answers": "...",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401unauthorized
404form_not_found

Example

curl -X POST "https://forms.mattering.io/api/user/v1/forms/SHORT_CODE/mappings/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "field_map": "...",
  "include_all_answers": "...",
  "is_active": "...",
  "static_values": "...",
  "target": "..."
}'

Source: FormsCore/internal_api.py (internal_api.form_mappings)

POSTDELETE forms/{short_code}/mappings/{mapping_id}/ User APIService tier

Spec §4.4 partial update + §4.5 delete.

URL

  • User APIhttps://forms.mattering.io/api/user/v1/forms/{short_code}/mappings/{mapping_id}/
  • Service tierhttps://forms.mattering.io/api/internal/forms/{short_code}/mappings/{mapping_id}/

Path parameters

NameType
short_codestr
mapping_iduuid

Body keys (JSON)

KeyRequiredDefault
field_mapoptional or conditionalnone
include_all_answersoptional or conditionalnone
is_activeoptional or conditionalnone
static_valuesoptional or conditionalnone
targetoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 bare JSON object (no envelope)

{
  "deleted": true,
  "id": "..."
}

200 bare JSON object (no envelope)

{
  "mapping": {
    "id": "...",
    "kind": "...",
    "target": "...",
    "node_type": "...",
    "connector_slug": "...",
    "instance_id": "...",
    "is_active": true,
    "target_space_id": "...",
    "target_project_id": "...",
    "target_widget_id": "...",
    "field_map": "...",
    "static_values": "...",
    "include_all_answers": "...",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400connector_mapping_readonly
401unauthorized
404form_not_found
404mapping_not_found

Example

curl -X POST "https://forms.mattering.io/api/user/v1/forms/SHORT_CODE/mappings/MAPPING_ID/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "field_map": "...",
  "include_all_answers": "...",
  "is_active": "...",
  "static_values": "...",
  "target": "..."
}'

Source: FormsCore/internal_api.py (internal_api.form_mapping_detail)

GET mapping-targets/ User APIService tier

Spec §4.1: the target catalog, serialized from TARGET_ATTRS.

Serialized, never copied: when a target gains an attr, consumers pick it up with no deploy on their side.

URL

  • User APIhttps://forms.mattering.io/api/user/v1/mapping-targets/
  • Service tierhttps://forms.mattering.io/api/internal/mapping-targets/

Responses

200 bare JSON object (no envelope)

{
  "targets": [
    {
      "target": "...",
      "label": "...",
      "service": "...",
      "needs_widget": "...",
      "notes_attr": "...",
      "attrs": [
        {
          "param": "...",
          "label": "...",
          "required": true
        }
      ]
    }
  ]
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401unauthorized

Example

curl -X GET "https://forms.mattering.io/api/user/v1/mapping-targets/" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: FormsCore/internal_api.py (internal_api.mapping_targets)

All Forms resources
Start Free Explore our Products