---
title: "Get Custom Fields Configuration"
method: GET
path: "/api/v1/custom-fields/configuration"
tags: ["Custom Fields"]
---

# Get Custom Fields Configuration

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

For a connector + (category, model), return the full custom-field configuration: every custom field with its effective mapping (connector overrides organization) and the source. Unmapped fields are included with null json_path so callers can see what is left to configure.

## Query parameters

- `connector_token` string, required — Connector token to compute the configuration for.
- `category` 'HRIS' | 'ATS' | 'LMS', required
- `model` string, required — Model slug to filter custom fields by.

## Response `200`

Successful Response

- EffectiveCustomFieldResponse
  - `connector_token` string, required — Connector the effective view was computed for.
  - `integration_slug` string, required — Slug of the integration this connector belongs to.
  - `category` 'HRIS' | 'ATS' | 'LMS', required
  - `model` string, required — Model filter applied.
  - `fields` EffectiveCustomFieldEntry[], required — Every custom field for this org matching (category, model), with the effective mapping per field. Includes unmapped fields so callers can see what is left to configure.
    - `custom_field_id` string, uuid, required — ID of the custom field.
    - `name` string, required — Name of the custom field.
    - `description` string, nullable — Description of the custom field.
    - `category` 'HRIS' | 'ATS' | 'LMS', required
    - `model` string, required — Model the custom field is applied to.
    - `json_path` string, nullable — The effective JMESPath in use for this field on this connector. Null when no mapping exists.
    - `source` string, nullable — Which mapping is in effect: 'connector' (connector-scoped override), 'organization' (org-scoped inherited), or null (no mapping configured).
    - `mapping_id` string, uuid, nullable — ID of the underlying mapping row, for editing. Null when unmapped.

## 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)