Sign in

v3

latestOpenAPI 3.1.02026-07-311255771.3 MB
General

Get custom fields with current mappings

Get all custom fields available on the specified integration. *This includes the mapping to the corresponding integration field if applicable

get/integrations/{integration_id}/custom-fields

Path parameters

integration_idstring required

GET /integrations/:integration_id/custom-fields Parameter

Query parameters

cursorstring

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_sizeinteger

The number of results to return per page. Maximum is 250.

The number of results to return per page. Maximum is 250.

Response

GET /integrations/:integration_id/custom-fields Positive response

status'success' required

Example response

{
  "data": {
    "results": [
      {
        "id": "D9CoSqqun6ix7uKEwb2kHBU1",
        "key": "unified_tax_id",
        "integration_field": {
          "id": "FFpTK47GhXnU6QAopPq2bdos",
          "key": "tax_id",
          "type": "DEFAULT",
          "label": "The employee's tax ID"
        },
        "model": "hris_employees",
        "label": null,
        "description": null
      }
    ],
    "next_cursor": null,
    "next": null
  }
}