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


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.get_integration_fields(integration_id="<id>", page_size=100)

    while res is not None:
        # Handle items

        res = res.next()
{
  "status": "success",
  "data": {
    "results": [
      {
        "id": "FFpTK47GhXnU6QAopPq2bdos",
        "key": "tax_id",
        "model": "hris_employees",
        "type": "DEFAULT",
        "label": "Tax ID",
        "is_passthrough_enabled": true,
        "is_writable": false
      }
    ],
    "next_cursor": null,
    "next": null
  }
}
This includes the mapping to your custom fields

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/integration-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. An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

​
page_size
integer<int64>
default:100

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

Required range: 1 <= x <= 2000

Response

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

​
status
string
required
Allowed value: "success"
​
data
object
required