Docs/Support/API/Tags & Categorization
Tags & Categorization API
Unified platform tagging endpoints to organize tickets, query incidents by root cause, and drive automated workflow routing.
Color Coded: Tags support hex color codes for instant visual recognition in agent consoles and reporting dashboards.
Returns all platform tags defined in the tenant context.
List TagsAuth
Fetch all platform tags defined in the tenant.
Status Codes
- Name
200- Type
- HTTP
- Description
- Tags list returned successfully
- Name
401- Type
- HTTP
- Description
- Unauthorized - missing or invalid access token
Request
GET/v1/support/tags
Response 200
Creates a new taxonomy tag with unique slug name and badge color.
Create TagAuth
Register a new tag for categorizing support issues.
Payload Example
{
"name": "vpn-gateway-down",
"color": "#EF4444"
}Status Codes
- Name
201- Type
- HTTP
- Description
- Tag created successfully
- Name
409- Type
- HTTP
- Description
- Tag with this name already exists
Request Parameters
- Name
name- Type
- string
- Required
- Description
- Unique slug-friendly tag identifier (e.g. "vpn-gateway-down").
- Name
color- Type
- string
- Example
- eg. #EF4444
- Description
- Hexadecimal color string for visual badges.
Request
POST/v1/support/tags
Response 201
Synchronizes the set of tags attached to a specific ticket.
Set Ticket TagsAuth
Update and sync tag associations for a ticket.
Payload Example
{
"tag_ids": [
"b11db18f-a9cb-4bb7-b844-32b0c1694f4a",
"c22eb290-bac0-4cc8-c955-43c1d2705g5b"
]
}Status Codes
- Name
200- Type
- HTTP
- Description
- Ticket tags updated successfully
- Name
404- Type
- HTTP
- Description
- Ticket not found
Request Parameters
- Name
tag_ids- Type
- UUID[]
- Required
- Description
- Array of tag UUIDs to associate with the ticket.
Request
PUT/v1/support/tickets/{id}/tags
Response 200
Deletes a tag from the workspace taxonomy and removes it from all associated tickets.
Delete TagAuth
Remove a tag definition.
Status Codes
- Name
200- Type
- HTTP
- Description
- Tag deleted successfully
- Name
403- Type
- HTTP
- Description
- Forbidden - requires Admin role
- Name
404- Type
- HTTP
- Description
- Tag not found
Request
DELETE/v1/support/tags/{id}
Response 200