GET
/
integrations
/
{integration_id}
/
custom-fields
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
  }
}

*This includes the mapping to the corresponding integration field if applicable

Authorizations

Authorization
string
headerrequired

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.

Response

200 - application/json
status
enum<string>
required
Available options:
success
data
object
required