Tags

Manage tags used across tickets. List tags with usage counts, create new ones, or remove unused tags.

The Tag object

name string

Tag name

count integer

Number of tickets using this tag

Endpoints

GET List Tags POST Create Tag

GET /api/v1/teams/{teamId}/tags

List Tags

List all tags with usage counts.

Code Examples

curl -X GET "https://www.cstar.help/api/v1/teams/{teamId}/tags" \
  -H "Authorization: Bearer sk_live_your_key"

Responses

200 Tag list

{
  "success": true,
  "data": [
    {
      "object": "tag",
      "name": "billing",
      "count": 23
    },
    {
      "object": "tag",
      "name": "login",
      "count": 15
    }
  ]
}

401 Authentication failed — missing or invalid API key

{
  "success": false,
  "error": {
    "type": "authentication_error",
    "code": "authentication_required",
    "message": "Invalid or expired API key",
    "doc_url": "https://www.cstar.help/developers/api-reference#authentication",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}

403 Insufficient permissions — wrong key type or team access

{
  "success": false,
  "error": {
    "type": "authorization_error",
    "code": "insufficient_permissions",
    "message": "Secret key required for this endpoint",
    "doc_url": "https://www.cstar.help/developers/api-reference#authentication",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}

429 Rate limit exceeded

{
  "success": false,
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 60 seconds",
    "doc_url": "https://www.cstar.help/developers/api-reference#rate-limiting",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}

POST /api/v1/teams/{teamId}/tags

Create Tag

Create a new tag.

Request Body

name string required