Skip to main content
GET
Get Custom Fields Configuration

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.