---
title: "List Custom Field Mappings"
method: GET
path: "/api/v1/custom-fields/mapping"
tags: ["Custom Fields"]
---

# List Custom Field Mappings

`GET /api/v1/custom-fields/mapping`

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

## Query parameters

- `integration_slug` string, nullable — Integration slug — return organization-scoped mappings for this integration.
- `connector_token` string, nullable — Connector token — return connector-scoped mappings for this connector.

## Response `200`

Successful Response

- CustomFieldMappingExternal[]
  - `id` string, uuid, required — Unique identifier of the mapping.
  - `custom_field_id` string, uuid, required — ID of the custom field this mapping belongs to.
  - `integration_slug` string, nullable — Integration slug. Set when the mapping is organization-scoped; null otherwise.
  - `connector_token` string, nullable — Connector token. Set when the mapping is connector-scoped; null otherwise.
  - `json_path` string, required — JMESPath expression used to extract the value from the upstream payload.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/versions/7da10dc93a21/schema)