v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Custom Fields

Get Custom Field

Get a custom field with all its mappings.

get/api/v1/custom-fields/{custom_field_id}

Path parameters

custom_field_idstring uuid required

Response

Successful Response

idstring uuid required

Unique identifier of the custom field.

namestring required

Name of the custom field (snake_case).

descriptionstring nullable

Description of the custom field.

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

modelstring required

Model on which the custom field is applied.

source'DASHBOARD' | 'API' required

created_atstring date-time required

updated_atstring date-time nullable

Example response

{
  "id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
  "name": "guardian_mobile",
  "description": "Employee's guardian mobile number",
  "model": "employee",
  "mappings": [
    {
      "id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
      "custom_field_id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
      "integration_slug": "workday",
      "connector_token": "i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T",
      "json_path": "data.employee.guardian_mobile"
    }
  ],
  "mapping_counts": {
    "total": 3,
    "organization": 1,
    "connector": 2
  }
}