List connector field mappings

List every field Corma can fill when it creates an account in this connector, with the expression that fills it. A connector Corma does not create accounts in has no such list and answers 404.

GET

/v1/connectors/{id}/field-mappings

GET

/connectors/{id}/field-mappings

curl -X GET "https://api.corma.io/v1/connectors/{id}/field-mappings" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
The identifier of the connector, as GET /connectors returned it, or the id of its connection. The kind.method form names the only connection of that integration; with several, it answers 409.
take
integer
query
Default:
50
skip
integer
query
Default:
0

Response

application/json200

pagination
PaginationResponseMeta
required
items
FieldMapping[]
required
refreshedAt
string<date-time> | null
required
The timestamp of the last catalog refresh. ISO 8601 format. Null when Corma never read the catalog of this connector.

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "targetFieldId": "string",
      "targetLabel": "string",
      "type": "string",
      "origin": "standard",
      "required": true,
      "note": "string",
      "expression": "string",
      "skipEmpty": true,
      "source": "default"
    }
  ],
  "refreshedAt": "2026-01-15T09:30:00Z"
}

GET

/connectors/{id}/field-mappings

curl -X GET "https://api.corma.io/v1/connectors/{id}/field-mappings" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "targetFieldId": "string",
      "targetLabel": "string",
      "type": "string",
      "origin": "standard",
      "required": true,
      "note": "string",
      "expression": "string",
      "skipEmpty": true,
      "source": "default"
    }
  ],
  "refreshedAt": "2026-01-15T09:30:00Z"
}

List connector field mappings - Corma Help Center | Productlane

API referenceConnectors

List connector field mappings

List every field Corma can fill when it creates an account in this connector, with the expression that fills it. A connector Corma does not create accounts in has no such list and answers 404.

GET

/v1/connectors/{id}/field-mappings

GET

/connectors/{id}/field-mappings

curl -X GET "https://api.corma.io/v1/connectors/{id}/field-mappings" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
The identifier of the connector, as GET /connectors returned it, or the id of its connection. The kind.method form names the only connection of that integration; with several, it answers 409.
take
integer
query
Default:
50
skip
integer
query
Default:
0

Response

application/json200

pagination
PaginationResponseMeta
required
items
FieldMapping[]
required
refreshedAt
string<date-time> | null
required
The timestamp of the last catalog refresh. ISO 8601 format. Null when Corma never read the catalog of this connector.

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "targetFieldId": "string",
      "targetLabel": "string",
      "type": "string",
      "origin": "standard",
      "required": true,
      "note": "string",
      "expression": "string",
      "skipEmpty": true,
      "source": "default"
    }
  ],
  "refreshedAt": "2026-01-15T09:30:00Z"
}

GET

/connectors/{id}/field-mappings

curl -X GET "https://api.corma.io/v1/connectors/{id}/field-mappings" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "targetFieldId": "string",
      "targetLabel": "string",
      "type": "string",
      "origin": "standard",
      "required": true,
      "note": "string",
      "expression": "string",
      "skipEmpty": true,
      "source": "default"
    }
  ],
  "refreshedAt": "2026-01-15T09:30:00Z"
}