v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Custom Fields

List Custom Field Mappings

List mappings for an integration slug or connector token. Provide exactly one of integration_slug or connector_token.

get/api/v1/custom-fields/mapping

Query parameters

integration_slugstring nullable

Integration slug — return organization-scoped mappings for this integration.

Example:workday

Integration slug — return organization-scoped mappings for this integration.

connector_tokenstring nullable

Connector token — return connector-scoped mappings for this connector.

Example:i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T

Connector token — return connector-scoped mappings for this connector.

Response

Successful Response

idstring uuid required

Unique identifier of the mapping.

custom_field_idstring uuid required

ID of the custom field this mapping belongs to.

integration_slugstring nullable

Integration slug. Set when the mapping is organization-scoped; null otherwise.

connector_tokenstring nullable

Connector token. Set when the mapping is connector-scoped; null otherwise.

json_pathstring required

JMESPath expression used to extract the value from the upstream payload.

created_atstring date-time required

updated_atstring date-time nullable

Example response

[
  {
    "id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
    "custom_field_id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
    "integration_slug": "workday",
    "connector_token": "i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T",
    "json_path": "data.employee.guardian_mobile"
  }
]