List connector field mappings
GET/integrations/connectors/{id}/field-mappings
Returns paginated field mappings for a specific connector, ordered by binding key and source field. Use this to review how CRM fields map to external system fields for a given connector.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | ID of the connector whose mappings to list. Example: |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Default: |
Responses
200 Paginated list of field mappings
Content type application/json, object.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object · ConnectorFieldMappingV1 | No | |
data[].id | integer | No | Auto-incremented primary key. |
data[].connector_account_id | integer | No | Parent connector ID. Example: |
data[].binding_key | string | No | Logical grouping for related mappings. Example: |
data[].source_field | string | No | CRM-side field path. Example: |
data[].target_field | string | No | External system field name. Example: |
data[].direction | string | No | Sync direction for this mapping. One of: |
data[].transform_rule | string, nullable | No | Optional transformation expression applied during sync. |
data[].sample_value | string, nullable | No | Example value for documentation purposes. Example: |
data[].is_required | boolean | No | Whether this field is mandatory during sync validation. Example: |
data[].status | string | No | Whether the mapping is applied during sync runs. One of: |
data[].created_by | integer, nullable | No | Tenant user ID who created or last updated this mapping. |
Example
{
"data": [
{
"id": 31,
"connector_account_id": 4,
"binding_key": "contacts",
"source_field": "email",
"target_field": "Email",
"direction": "bidirectional",
"transform_rule": null,
"sample_value": "customer@example.test",
"is_required": true,
"status": "active"
}
]
}Example request
curl -X GET "https://{tenant}.faciotech.net/api/v1/integrations/connectors/{id}/field-mappings" \
-H "Accept: application/json"