List custom fields

curl --request GET \
  --url https://api.kajabi.com/v1/custom_fields \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kajabi.com/v1/custom_fields"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kajabi.com/v1/custom_fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/custom_fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/custom_fields"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kajabi.com/v1/custom_fields")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/custom_fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "title": "<string>",
        "handle": "<string>",
        "type": "<string>",
        "required": true
      },
      "relationships": {
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Custom Fields

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

GET

custom_fields

List custom fields

curl --request GET \
  --url https://api.kajabi.com/v1/custom_fields \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kajabi.com/v1/custom_fields"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kajabi.com/v1/custom_fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/custom_fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/custom_fields"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kajabi.com/v1/custom_fields")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/custom_fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {
        "title": "<string>",
        "handle": "<string>",
        "type": "<string>",
        "required": true
      },
      "relationships": {
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort

string

Sort order, use: title, handle, type, required for descending order use '-' e.g. &sort=-title

page[number]

number

page[size]

number

Number of documents

fields[custom_fields]

string

Partial attributes as specified, e.g. fields[custom_fields]=handle,title,required

filter[site_id]

string

Filter by site_id, for example ?filter[site_id]=111

filter[title_cont]

string

Filter by title contains, for example ?filter[title_cont]=favorite

filter[type_eq]

string

Filter by field type equals, for example ?filter[type_eq]=TextField

filter[required_eq]

string

Filter by required field equals, for example ?filter[required_eq]=true

Response

Success, list of custom fields which the current user may access

data

object[]

Show child attributes

links

object

Show child attributes

Course details

Custom field details