Skip to main content
GET
/
field-mappings
/
{selector}
Get field mapping by selector
curl --request GET \
  --url https://api.getmembrane.com/field-mappings/{selector} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "uuid": "<string>",
  "key": "<string>",
  "description": "<string>",
  "meta": {},
  "state": "BUILDING",
  "errors": [
    {
      "message": "<string>",
      "type": "bad_request",
      "key": "<string>",
      "data": {},
      "stack": {},
      "causedByError": "<unknown>",
      "logs": [
        {}
      ]
    }
  ],
  "revision": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "archivedAt": "<string>",
  "isDeactivated": true,
  "isReadOnly": true,
  "integrationId": "<string>",
  "integrationUuid": "<string>",
  "integrationKey": "<string>",
  "parentUuid": "<string>",
  "parentKey": "<string>",
  "connectionId": "<string>",
  "instanceKey": "<string>",
  "isUniversal": true,
  "externalAppId": "<string>",
  "externalAppUuid": "<string>",
  "externalAppKey": "<string>",
  "fieldMappingId": "<string>",
  "universalFieldMappingId": "<string>",
  "dataSourceId": "<string>",
  "dataSourceUuid": "<string>",
  "appSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "direction": "import",
  "defaultImportValue": {},
  "defaultExportValue": {},
  "importValue": {},
  "exportValue": {},
  "unifiedImportValue": {},
  "unifiedExportValue": {},
  "frozenImportFields": {},
  "frozenExportFields": {},
  "frozenUnifiedExportFields": {},
  "isCustomized": true,
  "userId": "<string>",
  "tenantId": "<string>",
  "fieldMappingRevision": "<string>",
  "universalFieldMappingRevision": "<string>",
  "dataSourceInstanceId": "<string>",
  "dataSourceSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "error": {
    "message": "<string>",
    "type": "bad_request",
    "key": "<string>",
    "data": {},
    "stack": {},
    "causedByError": "<unknown>",
    "logs": [
      {}
    ]
  },
  "integration": {
    "id": "<string>",
    "name": "<string>",
    "logoUri": "<string>",
    "uuid": "<string>",
    "key": "<string>",
    "description": "<string>",
    "meta": {},
    "state": "BUILDING",
    "errors": [
      {
        "message": "<string>",
        "type": "bad_request",
        "key": "<string>",
        "data": {},
        "stack": {},
        "causedByError": "<unknown>",
        "logs": [
          {}
        ]
      }
    ],
    "revision": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "archivedAt": "<string>",
    "isDeactivated": true,
    "isReadOnly": true,
    "connectorId": "<string>",
    "connectorVersion": "<string>",
    "oAuthCallbackUri": "<string>",
    "parameters": {},
    "hasMissingParameters": true,
    "hasDocumentation": true,
    "hasOperations": true,
    "operationsCount": 123,
    "hasData": true,
    "dataCollectionsCount": 123,
    "hasEvents": true,
    "eventsCount": 123,
    "hasGlobalWebhooks": true,
    "hasUdm": true,
    "isTest": true,
    "externalAppId": "<string>",
    "authType": "integration-app-token",
    "optionsConfig": {}
  },
  "appliedToIntegrations": [
    {
      "element": {
        "id": "<string>",
        "name": "<string>",
        "uuid": "<string>",
        "key": "<string>",
        "description": "<string>",
        "meta": {},
        "state": "BUILDING",
        "errors": [
          {
            "message": "<string>",
            "type": "bad_request",
            "key": "<string>",
            "data": {},
            "stack": {},
            "causedByError": "<unknown>",
            "logs": [
              {}
            ]
          }
        ],
        "revision": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "archivedAt": "<string>",
        "isDeactivated": true,
        "isReadOnly": true,
        "integrationId": "<string>",
        "integrationUuid": "<string>",
        "integrationKey": "<string>",
        "parentUuid": "<string>",
        "parentKey": "<string>",
        "connectionId": "<string>",
        "instanceKey": "<string>",
        "isUniversal": true,
        "externalAppId": "<string>",
        "externalAppUuid": "<string>",
        "externalAppKey": "<string>",
        "fieldMappingId": "<string>",
        "universalFieldMappingId": "<string>",
        "dataSourceId": "<string>",
        "dataSourceUuid": "<string>",
        "appSchema": {
          "type": "<string>",
          "title": "<string>",
          "description": "<string>",
          "format": "<string>",
          "properties": {},
          "items": "<unknown>",
          "additionalProperties": true,
          "enum": [
            "<string>"
          ],
          "referenceRecords": [
            {}
          ],
          "referenceCollection": {
            "key": {},
            "parameters": {}
          },
          "referenceUdm": "<string>",
          "default": {},
          "allowCustom": true,
          "required": [
            "<string>"
          ],
          "minLength": 123,
          "maxLength": 123,
          "minimum": 123,
          "maximum": 123,
          "maxItems": 123,
          "readOnly": true,
          "writeOnly": true,
          "examples": [
            {}
          ],
          "anyOf": "<array>",
          "isImplied": true,
          "isSensitive": true,
          "referenceCollectionPath": "<string>",
          "referenceCollectionUri": "<string>"
        },
        "direction": "import",
        "defaultImportValue": {},
        "defaultExportValue": {},
        "importValue": {},
        "exportValue": {},
        "unifiedImportValue": {},
        "unifiedExportValue": {},
        "frozenImportFields": {},
        "frozenExportFields": {},
        "frozenUnifiedExportFields": {},
        "isCustomized": true,
        "userId": "<string>",
        "tenantId": "<string>",
        "fieldMappingRevision": "<string>",
        "universalFieldMappingRevision": "<string>",
        "dataSourceInstanceId": "<string>",
        "dataSourceSchema": {
          "type": "<string>",
          "title": "<string>",
          "description": "<string>",
          "format": "<string>",
          "properties": {},
          "items": "<unknown>",
          "additionalProperties": true,
          "enum": [
            "<string>"
          ],
          "referenceRecords": [
            {}
          ],
          "referenceCollection": {
            "key": {},
            "parameters": {}
          },
          "referenceUdm": "<string>",
          "default": {},
          "allowCustom": true,
          "required": [
            "<string>"
          ],
          "minLength": 123,
          "maxLength": 123,
          "minimum": 123,
          "maximum": 123,
          "maxItems": 123,
          "readOnly": true,
          "writeOnly": true,
          "examples": [
            {}
          ],
          "anyOf": "<array>",
          "isImplied": true,
          "isSensitive": true,
          "referenceCollectionPath": "<string>",
          "referenceCollectionUri": "<string>"
        },
        "error": {
          "message": "<string>",
          "type": "bad_request",
          "key": "<string>",
          "data": {},
          "stack": {},
          "causedByError": "<unknown>",
          "logs": [
            {}
          ]
        }
      },
      "integration": {
        "id": "<string>",
        "name": "<string>",
        "logoUri": "<string>",
        "uuid": "<string>",
        "key": "<string>",
        "description": "<string>",
        "meta": {},
        "state": "BUILDING",
        "errors": [
          {
            "message": "<string>",
            "type": "bad_request",
            "key": "<string>",
            "data": {},
            "stack": {},
            "causedByError": "<unknown>",
            "logs": [
              {}
            ]
          }
        ],
        "revision": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "archivedAt": "<string>",
        "isDeactivated": true,
        "isReadOnly": true,
        "connectorId": "<string>",
        "connectorVersion": "<string>",
        "oAuthCallbackUri": "<string>",
        "parameters": {},
        "hasMissingParameters": true,
        "hasDocumentation": true,
        "hasOperations": true,
        "operationsCount": 123,
        "hasData": true,
        "dataCollectionsCount": 123,
        "hasEvents": true,
        "eventsCount": 123,
        "hasGlobalWebhooks": true,
        "hasUdm": true,
        "isTest": true,
        "externalAppId": "<string>",
        "authType": "integration-app-token",
        "optionsConfig": {}
      }
    }
  ],
  "user": {
    "id": "<string>",
    "name": "<string>",
    "internalId": "<string>",
    "meta": {},
    "fields": {},
    "credentials": {},
    "lastActiveAt": "<string>",
    "isTest": true,
    "isBillable": true,
    "isActive": true,
    "aiCreditsRolling30DayLimit": 1,
    "createdAt": "<string>",
    "archivedAt": "<string>"
  },
  "connection": {
    "id": "<string>",
    "name": "<string>",
    "userId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "tenantId": "<string>",
    "key": "<string>",
    "isTest": true,
    "connected": true,
    "disconnected": true,
    "isDefunct": true,
    "state": "BUILDING",
    "errors": [
      {
        "message": "<string>",
        "type": "bad_request",
        "key": "<string>",
        "data": {},
        "stack": {},
        "causedByError": "<unknown>",
        "logs": [
          {}
        ]
      }
    ],
    "requestError": {
      "message": "<string>",
      "type": "bad_request",
      "key": "<string>",
      "data": {},
      "stack": {},
      "causedByError": "<unknown>",
      "logs": [
        {}
      ]
    },
    "error": {
      "message": "<string>",
      "type": "bad_request",
      "key": "<string>",
      "data": {},
      "stack": {},
      "causedByError": "<unknown>",
      "logs": [
        {}
      ]
    },
    "integrationId": "<string>",
    "connectorId": "<string>",
    "externalAppId": "<string>",
    "connectorVersion": "<string>",
    "authOptionKey": "<string>",
    "lastActiveAt": "<string>",
    "nextCredentialsRefreshAt": "<string>",
    "nextRetryTimestamp": "<string>",
    "retryAttempts": 123,
    "canTest": true,
    "canRefreshCredentials": true,
    "archivedAt": "<string>",
    "isDeactivated": true,
    "meta": {},
    "buildingAgentSessionId": "<string>",
    "clientAction": {
      "type": "connect",
      "description": "<string>",
      "uiUrl": "<string>",
      "agentInstructions": "<string>"
    }
  },
  "fieldMapping": {
    "id": "<string>",
    "name": "<string>",
    "uuid": "<string>",
    "key": "<string>",
    "description": "<string>",
    "meta": {},
    "state": "BUILDING",
    "errors": [
      {
        "message": "<string>",
        "type": "bad_request",
        "key": "<string>",
        "data": {},
        "stack": {},
        "causedByError": "<unknown>",
        "logs": [
          {}
        ]
      }
    ],
    "revision": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "archivedAt": "<string>",
    "isDeactivated": true,
    "isReadOnly": true,
    "integrationId": "<string>",
    "integrationUuid": "<string>",
    "integrationKey": "<string>",
    "parentUuid": "<string>",
    "parentKey": "<string>",
    "connectionId": "<string>",
    "instanceKey": "<string>",
    "isUniversal": true,
    "externalAppId": "<string>",
    "externalAppUuid": "<string>",
    "externalAppKey": "<string>",
    "fieldMappingId": "<string>",
    "universalFieldMappingId": "<string>",
    "dataSourceId": "<string>",
    "dataSourceUuid": "<string>",
    "appSchema": {
      "type": "<string>",
      "title": "<string>",
      "description": "<string>",
      "format": "<string>",
      "properties": {},
      "items": "<unknown>",
      "additionalProperties": true,
      "enum": [
        "<string>"
      ],
      "referenceRecords": [
        {}
      ],
      "referenceCollection": {
        "key": {},
        "parameters": {}
      },
      "referenceUdm": "<string>",
      "default": {},
      "allowCustom": true,
      "required": [
        "<string>"
      ],
      "minLength": 123,
      "maxLength": 123,
      "minimum": 123,
      "maximum": 123,
      "maxItems": 123,
      "readOnly": true,
      "writeOnly": true,
      "examples": [
        {}
      ],
      "anyOf": "<array>",
      "isImplied": true,
      "isSensitive": true,
      "referenceCollectionPath": "<string>",
      "referenceCollectionUri": "<string>"
    },
    "direction": "import",
    "defaultImportValue": {},
    "defaultExportValue": {},
    "importValue": {},
    "exportValue": {},
    "unifiedImportValue": {},
    "unifiedExportValue": {},
    "frozenImportFields": {},
    "frozenExportFields": {},
    "frozenUnifiedExportFields": {},
    "isCustomized": true,
    "userId": "<string>",
    "tenantId": "<string>",
    "fieldMappingRevision": "<string>",
    "universalFieldMappingRevision": "<string>",
    "dataSourceInstanceId": "<string>",
    "dataSourceSchema": {
      "type": "<string>",
      "title": "<string>",
      "description": "<string>",
      "format": "<string>",
      "properties": {},
      "items": "<unknown>",
      "additionalProperties": true,
      "enum": [
        "<string>"
      ],
      "referenceRecords": [
        {}
      ],
      "referenceCollection": {
        "key": {},
        "parameters": {}
      },
      "referenceUdm": "<string>",
      "default": {},
      "allowCustom": true,
      "required": [
        "<string>"
      ],
      "minLength": 123,
      "maxLength": 123,
      "minimum": 123,
      "maximum": 123,
      "maxItems": 123,
      "readOnly": true,
      "writeOnly": true,
      "examples": [
        {}
      ],
      "anyOf": "<array>",
      "isImplied": true,
      "isSensitive": true,
      "referenceCollectionPath": "<string>",
      "referenceCollectionUri": "<string>"
    },
    "error": {
      "message": "<string>",
      "type": "bad_request",
      "key": "<string>",
      "data": {},
      "stack": {},
      "causedByError": "<unknown>",
      "logs": [
        {}
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
selector
string
required

Query Parameters

​
layer
enum<string>
Available options:
universal,
integration,
connection
​
integrationKey
string
​
integrationId
string
​
connectionId
string
​
connectionKey
string
​
instanceKey
string

Response

200 - application/json
​
id
string
required

Internal database ID of the element. Assigned by the API; unique per element.

​
name
string
required

Display name. Always present in API responses (filled by API if not set on create).

​
uuid
string

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

​
key
string

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

​
description
string

Optional human-readable description.

​
meta
object

Optional key-value metadata.

​
state
enum<string>
Available options:
BUILDING,
CLIENT_ACTION_REQUIRED,
CONFIGURATION_ERROR,
SETUP_FAILED,
READY,
DISCONNECTING
​
errors
object[]

Validation or setup errors when state is not READY.

​
revision
string

Opaque revision token; changes on each update. Used for optimistic concurrency.

​
createdAt
string

ISO date when the element was created.

​
updatedAt
string

ISO date when the element was last updated.

​
archivedAt
string

When set, the element is archived (soft-deleted). Archived elements cannot be patched.

​
isDeactivated
boolean

When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).

​
isReadOnly
boolean

When true, the element cannot be modified (e.g. published package elements or elements from another workspace).

​
integrationId
string

Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.

​
integrationUuid
string

UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.

​
integrationKey
string

Key of the integration; alternative to integrationId. Resolved to integrationId by the API.

​
parentUuid
string

UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.

​
parentKey
string

Key of the parent element; alternative to parentId. Resolved to parentId by the API.

​
connectionId
string
​
instanceKey
string
​
isUniversal
boolean

When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.

​
externalAppId
string

Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.

​
externalAppUuid
string

UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.

​
externalAppKey
string

Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.

​
fieldMappingId
string
​
universalFieldMappingId
string
​
dataSourceId
string
​
dataSourceUuid
string
​
appSchema
object
​
direction
enum<string>
Available options:
import,
export,
both
​
defaultImportValue
object
​
defaultExportValue
object
​
importValue
object
​
exportValue
object
​
unifiedImportValue
object
​
unifiedExportValue
object
​
frozenImportFields
object
​
frozenExportFields
object
​
frozenUnifiedExportFields
object
​
isCustomized
boolean
​
userId
string
​
tenantId
string
​
fieldMappingRevision
string
​
universalFieldMappingRevision
string
​
dataSourceInstanceId
string
​
dataSourceSchema
object
​
error
object
​
integration
object
​
appliedToIntegrations
object[]
​
user
object
​
connection
object
​
fieldMapping
object