List custom fields

Custom Field attributes

The ‘handle’ attribute may be used as a key for a contact resource, e.g. custom_1, custom_2, custom_3

Pagination

Use page[number] and page[size] parameters to paginate results:

Get first page of 10 items

• GET /v1/custom_fields?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/custom_fields?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://app.kajabi.com/api/v1/custom_fields?page[number]=2&page[size]=10",
    "first": "https://app.kajabi.com/api/v1/custom_fields?page[number]=1&page[size]=10",
    "prev": "https://app.kajabi.com/api/v1/custom_fields?page[number]=1&page[size]=10",
    "next": "https://app.kajabi.com/api/v1/custom_fields?page[number]=3&page[size]=10",
    "last": "https://app.kajabi.com/api/v1/custom_fields?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Filter by Site ID

Use the filter[site_id] parameter to get custom fields for a specific site:

Get custom fields for site with ID 123

• GET /v1/custom_fields?filter[site_id]=123

Response will only include custom fields for that site

{
  "data": [
    {
      "id": "123",
      "type": "custom_fields",
      "attributes": {
        "handle": "custom_1",
        "title": "Favorite Song",
        "type": "TextField",
        "required": false
      },
      "relationships": {
        "site": {
          "data": {
            "id": "123",
            "type": "sites"
          }
        }
      }
    }
  ]
}

Sorting

Use the sort parameter to sort the results:

Sort by title in ascending order

• GET /v1/custom_fields?sort=title

Sort by title in descending order

• GET /v1/custom_fields?sort=-title

Filter by Title Contains

Use the filter[title_cont] parameter to find custom fields where the title contains specific text:

Get custom fields with titles containing “favorite”

• GET /v1/custom_fields?filter[title_cont]=favorite

Response will include custom fields with matching titles

{
  "data": [{
    "id": "123",
    "type": "custom_fields",
    "attributes": {
      "handle": "custom_1",
      "title": "Favorite Song",
      "type": "TextField",
      "required": false
    }
  },
  {
    "id": "456",
    "type": "custom_fields",
    "attributes": {
      "handle": "custom_2",
      "title": "Favorite Movie",
      "type": "TextField",
      "required": false
    }
  }]
}

Filter by Required Field

Use the filter[required_eq] parameter to find custom fields based on their required status:

Get custom fields that are required

• GET /v1/custom_fields?filter[required_eq]=true

Response will include custom fields that are required

{
  "data": [{
    "id": "123",
    "type": "custom_fields",
    "attributes": {
      "handle": "custom_1",
      "title": "Phone Number",
      "type": "TextField",
      "required": true
    }
  }]
}

Using Multiple Parameters Together

You can combine pagination, sorting, sparse fields and filtering in a single request:

Get page 2 of custom fields for site 123, sorted by title descending, including only handle and title fields

• GET /v1/custom_fields?page[number]=2&page[size]=10&sort=-title&filter[site_id]=123&fields[custom_fields]=handle,title

Response will include paginated and filtered custom fields with sparse fields

{
  "data": [
    {
      "id": "456",
      "type": "custom_fields",
      "attributes": {
        "handle": "custom_2",
        "title": "Favorite Movie"
      },
      "relationships": {
        "site": {
          "data": {
            "id": "123",
            "type": "sites"
          }
        }
      }
    }
  ],
  "links": {
    "self": "https://app.kajabi.com/api/v1/custom_fields?page[number]=2&page[size]=10&sort=-title&filter[site_id]=123&fields[custom_fields]=handle,title",
    "first": "https://app.kajabi.com/api/v1/custom_fields?page[number]=1&page[size]=10&sort=-title&filter[site_id]=123&fields[custom_fields]=handle,title",
    "prev": "https://app.kajabi.com/api/v1/custom_fields?page[number]=1&page[size]=10&sort=-title&filter[site_id]=123&fields[custom_fields]=handle,title",
    "next": null,
    "last": "https://app.kajabi.com/api/v1/custom_fields?page[number]=2&page[size]=10&sort=-title&filter[site_id]=123&fields[custom_fields]=handle,title"
  },
  "meta": {
    "total_pages": 2,
    "total_count": 15,
    "current_page": 2
  }
}