Docs
API Reference

Tags Endpoint

List and create tags for organising tickets.

List tags

GET /tags

Scopes required: tickets:read

Response:

{
  "tags": [
    {
      "id": "tag_01abc...",
      "name": "billing",
      "ticketCount": 42,
      "createdAt": "2025-01-01T00:00:00Z"
    }
  ]
}

Create a tag

POST /tags

Scopes required: tickets:write

Request body:

{
  "name": "enterprise"
}

Tag names are case-insensitive and normalised to lowercase. If a tag with this name already exists, the existing tag is returned.

Response: The created (or existing) tag object.

Using tags

Tags are applied to tickets via the PATCH /tickets/:id endpoint:

{
  "tags": ["billing", "enterprise"]
}

This replaces the ticket's current tags with the new list. To add a tag without removing others, first fetch the current tags and include them in the request.

On this page