Skip to main content
GET
/
integrations
/
{integration_id}
/
custom-fields
Python
from kombo import SDK


with SDK(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.general.get_custom_fields(integration_id="<id>", page_size=100)

    while res is not None:
        # Handle items

        res = res.next()
{
  "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
  }
}

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
}