Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Custom Fields

Get 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.

get/api/v1/custom-fields/configuration

Query parameters

connector_tokenstring required

Connector token to compute the configuration for.

Example:i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T

Connector token to compute the configuration for.

category'HRIS' | 'ATS' | 'LMS' required

Category to filter custom fields by.

modelstring required

Model slug to filter custom fields by.

Example:employee

Model slug to filter custom fields by.

Response

Successful Response

connector_tokenstring required

Connector the effective view was computed for.

integration_slugstring required

Slug of the integration this connector belongs to.

category'HRIS' | 'ATS' | 'LMS' required
modelstring required

Model filter applied.

Example response

{
  "integration_slug": "workday",
  "model": "employee",
  "fields": [
    {
      "custom_field_id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
      "name": "guardian_mobile",
      "model": "employee",
      "json_path": "data.employee.guardian_mobile",
      "source": "connector",
      "mapping_id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734"
    }
  ]
}