ContactsContact Tags

List Contact Tags

Get all contact tags in your project.

Returns a paginated list of contact tags in your project.

Required: Contacts > Read

POST
/getAllContactTags

Authorization

bearerToken

AuthorizationBearer <token>

API token for YourGPT Public APIs. Create tokens in Settings > API Tokens in your YourGPT dashboard.

In: header

Request Body

application/json

project_uid*string

Your project's unique identifier.

search?string

Search tags by name.

limit?integer

Records per page.

Default10
page?integer

Page number.

Default1
orderBy?string

Sort order.

Value in"ASC" | "DESC"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/getAllContactTags" \  -H "Content-Type: application/json" \  -d '{    "project_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"  }'
{
  "type": "RXSUCCESS",
  "total": 8,
  "data": [
    {
      "id": 501,
      "name": "vip",
      "project_id": 12345,
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ]
}
{
  "type": "RXERROR",
  "message": "Invalid params"
}
{
  "type": "RXERROR",
  "message": "Invalid or revoked API token"
}
{
  "type": "RXERROR",
  "message": "You do not have permission to perform this action"
}