List All Contact Tags via the ChatbotX REST API

Tags let you categorise and segment your contacts for targeted messaging and automation. Use this endpoint to retrieve all tags defined in your workspace. You can paginate through results and search by keyword to locate specific tags quickly.

GET /api/v1/tags

Query Parameters

integer

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

integer

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

string

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

Code Examples

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

import requests

url = "https://app.chatbotx.io/api/v1/tags"

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/tags?page=1&perPage=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 200 OK with a data array of tag objects.

Response Fields

array

required

Array of tag objects belonging to the workspace.

Show data item fields

string

required

Unique identifier for the tag.

string

required

Display name of the tag.

string

The ID of the workspace this tag belongs to.

string | null

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

Example Response

{
  "data": [
    {
      "id": "201",
      "name": "VIP Customer",
      "workspaceId": "42",
      "folderId": null
    },
    {
      "id": "202",
      "name": "Newsletter Subscriber",
      "workspaceId": "42",
      "folderId": "3"
    }
  ]
}

⌘I

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

List All Contact Tags via the ChatbotX REST 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