---
title: "Get custom fields with current mappings"
method: GET
path: "/integrations/{integration_id}/custom-fields"
tags: ["General"]
---

# Get custom fields with current mappings

`GET /integrations/{integration_id}/custom-fields`

Get all custom fields available on the specified integration.
**This includes the mapping to the corresponding integration field if applicable*

## Path parameters

- `integration_id` string, required

## 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 — The number of results to return per page. Maximum is 250.

## Response `200`

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

- GetIntegrationsIntegrationIdCustomFieldsPositiveResponse
  - `status` 'success', required
  - `data` object, required
    - `results` object[], required
      - `id` string, required — The unique ID of the field
      - `key` string, required — The key of the custom field as it will be used in the custom_field object of the corresponding model
      - `integration_field` object, nullable, required — The integration field the custom field is mapped to. Null if not mapped.
        - `id` string, required — The integration field's unique ID
        - `key` string, required — The key of the integration field in the remote system
        - `type` 'DEFAULT' | 'CUSTOM', required — The type of the integration field. There is a type to avoid collisions between DEFAULT fields and CUSTOM fields with the same key.
        - `label` string, nullable, required — The label of the integration field in the remote system
      - `model` string, required — The model the field is associated with
      - `label` string, nullable, required — The label of the custom field
      - `description` string, nullable, required — The description of the custom field
    - `next_cursor` string, nullable, required — **(⚠️ Deprecated - Use `next` instead.)** Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages.
    - `next` string, nullable, required — Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages.

## Other responses

- `default` — The standard error response with just the platform error codes.

---

[API](https://skmtc.net/kombo/apis/kombo-api.md) · [All operations](https://skmtc.net/kombo/apis/kombo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kombo/kombo-api/revisions/1e45035b96d3/schema)