List All Contact Custom Fields via the ChatbotX API

Custom fields let you store structured data against your contacts — such as short text, numbers, dates, or booleans. Use this endpoint to retrieve all custom fields defined in your workspace. You can paginate through results and search by keyword to find specific fields quickly.

GET /api/v1/custom-fields

Query Parameters

integer

The page number to retrieve. Must be 1 or greater. Defaults to 1.

integer

Number of custom fields to return per page. Must be 1 or greater.

string

Filter custom fields by name. Returns all fields whose name contains the provided keyword (case-insensitive).

Code Examples

curl --request GET \
  --url 'https://app.chatbotx.io/api/v1/custom-fields?page=1&perPage=20' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.chatbotx.io/api/v1/custom-fields"

params = {"page": 1, "perPage": 20}
headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, params=params, headers=headers)
print(response.json())

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

fetch('https://app.chatbotx.io/api/v1/custom-fields?page=1&perPage=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns a 200 OK with a data array of custom field objects.

Response Fields

array

required

Array of custom field objects belonging to the workspace.

Show data item fields

string

required

Unique identifier for the custom field.

string

required

Display name of the custom field.

string

required

The data type of the field. One of shortText, longText, number, date, datetime, boolean, email, or phoneNumber.

string

required

The ID of the workspace this field belongs to.

string | null

The folder this field is organised into, or null if it is not in a folder.

string | null

An optional description of the custom field’s purpose.

Example Response

{
  "data": [
    {
      "id": "101",
      "name": "Favourite Colour",
      "type": "shortText",
      "workspaceId": "42",
      "folderId": null,
      "description": "The contact's self-reported favourite colour."
    },
    {
      "id": "102",
      "name": "Date of Birth",
      "type": "date",
      "workspaceId": "42",
      "folderId": "7",
      "description": null
    }
  ]
}

⌘I

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

List All Contact Custom Fields via the ChatbotX API

Query Parameters

Code Examples

Response

Response Fields

Example Response

​Query Parameters

​Code Examples

​Response

​Response Fields

​Example Response

Query Parameters

Code Examples

Response

Response Fields

Example Response