KOkombo
General

Get integration fields

Changed on

Get all fields available on the specified integration. This includes the mapping to your custom fields

get/integrations/{integration_id}/integration-fields

Request

Path parameters

integration_idstring required

GET /integrations/:integration_id/integration-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.

page_sizeinteger

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

Response

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

status'success' required

Example response

{
  "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
  }
}

Changes