Custom field details

Custom Field attributes

• handle (string) - The key for a contact resource, e.g. custom_1, custom_2, custom_3
• title (string) - The title of the custom field
• type (string) - The type of the custom field
• required (boolean) - Whether the custom field is required
• archived (boolean) - Whether the custom field is archived

Sparse Fields

Use the fields[custom_fields] parameter to include only specific attributes:

Include only handle and title fields

• GET /v1/custom_fields/123?fields[custom_fields]=handle,title

Response will include only the specified fields

{
  "data": {
    "id": "123",
    "type": "custom_fields",
    "attributes": {
      "handle": "custom_1",
      "title": "Favorite Song"
    }
  }
}

GET /v1/custom_fields/{id}

Custom field details

cURL

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

200

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

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Query Parameters

fields[custom_fields] · string

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

Response

200

application/vnd.api+json

Success, shows details of a custom field

data · object

Show child attributes

links · object

Show child attributes