v1

latestOpenAPI 3.0.32026-07-268955212.1 KB

tag-groups

[Preview] Get all tag groups

Retrieve all tag groups for the company, including their tags.

The company must have the Tags feature enabled in their price plan.

Preview: This endpoint is in preview and may change or be removed before general availability. Read the full preview policy

Scope: tags:read

get/companies/{companyId}/tag-groups

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page for pagination

querystring

Optional query to filter the data set with supported fields listed below and available operations.

Field	Type
name	string
dimensionNumber	integer

Response

Tag groups found

totalItemsinteger

totalPagesinteger

currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Project",
      "alias": "@",
      "dimensionNumber": 6,
      "tags": [
        {
          "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
          "name": "Project Alpha"
        },
        {
          "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
          "name": "Project Beta"
        }
      ]
    }
  ]
}