Skip to main content
GET
/
v4
/
custom_fields
List custom fields
curl --request GET \
  --url https://api.kit.com/v4/custom_fields \
  --header 'X-Kit-Api-Key: <api-key>'
{
  "custom_fields": [
    {
      "id": 1,
      "name": "ck_field_1_last_name",
      "key": "last_name",
      "label": "Last name"
    }
  ],
  "pagination": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "WzFd",
    "end_cursor": "WzFd",
    "per_page": 500
  }
}

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Query Parameters

​
after
any | null

To fetch next page of results, use ?after=<end_cursor>

​
before
any | null

To fetch previous page of results, use ?before=<start_cursor>

​
include_total_count
boolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

​
per_page
any | null

Number of results per page. Default 500, maximum 1000.

Response

Returns a paginated list of all custom fields for your account

​
custom_fields
object[]
required
​
pagination
object
required