---
title: "Get Custom Field"
method: GET
path: "/api/v1/custom-fields/{custom_field_id}"
tags: ["Custom Fields"]
---

# Get Custom Field

`GET /api/v1/custom-fields/{custom_field_id}`

Get a custom field with all its mappings.

## Path parameters

- `custom_field_id` string, uuid, required

## Response `200`

Successful Response

- CustomFieldDetailExternal
  - `id` string, uuid, required — Unique identifier of the custom field.
  - `name` string, required — Name of the custom field (snake_case).
  - `description` string, nullable — Description of the custom field.
  - `category` 'HRIS' | 'ATS' | 'LMS', required
  - `model` string, required — Model on which the custom field is applied.
  - `source` 'DASHBOARD' | 'API', required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable
  - `mappings` CustomFieldMappingExternal[] — All mappings configured for this custom field.
    - `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
  - `mapping_counts` CustomFieldMappingCounts, required
    - `total` integer, required — Total number of mappings configured for this custom field.
    - `organization` integer, required — Number of organization-scoped (integration-level) mappings.
    - `connector` integer, required — Number of connector-scoped mappings.

## 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.
- `404` — The requested resource was not found.
- `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/revisions/7da10dc93a21/schema)