GET
/
integrations
/
{integration_id}
/
custom-fields
Get custom fields with current mappings
curl --request GET \
  --url https://api.kombo.dev/v1/integrations/{integration_id}/custom-fields \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "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
  }
}
*This includes the mapping to the corresponding integration field if applicable

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Path Parameters

​
integration_id
string
required

GET /integrations/:integration_id/custom-fields Parameter

Query Parameters

​
cursor
string

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

​
page_size
integer
default:100

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

Required range: 1 <= x <= 250

Response

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

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples:
{
  "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
}