Skip to main content
GET
/
api
/
v1
/
custom-fields
/
configuration
Get Custom Fields Configuration
curl --request GET \
  --url https://api.bindbee.dev/api/v1/custom-fields/configuration \
  --header 'Authorization: Bearer <token>'
{
  "connector_token": "<string>",
  "integration_slug": "<string>",
  "category": "HRIS",
  "model": "<string>",
  "fields": [
    {
      "custom_field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "category": "HRIS",
      "model": "<string>",
      "description": "<string>",
      "json_path": "data.employee.guardian_mobile",
      "source": "connector",
      "mapping_id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.bindbee.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
connector_token
string
required

Connector token to compute the configuration for.

Example:

"i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"

​
category
enum<string>
required

Category to filter custom fields by.

Available options:
HRIS,
ATS,
LMS
Example:

"HRIS"

​
model
string
required

Model slug to filter custom fields by.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_-]*$
Example:

"employee"

Response

Successful Response

​
connector_token
string
required

Connector the effective view was computed for.

​
integration_slug
string
required

Slug of the integration this connector belongs to.

Example:

"workday"

​
category
enum<string>
required

Category filter applied.

Available options:
HRIS,
ATS,
LMS
Example:

"HRIS"

​
model
string
required

Model filter applied.

Example:

"employee"

​
fields
EffectiveCustomFieldEntry · object[]
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.