v1

latestOpenAPI 3.0.32026-07-268955212.1 KB

tag-groups

[Preview] Get a tag group by ID

Retrieve a specific tag group by its ID, including all its 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/{tagGroupId}

Response

Tag group found

idstring uuid

Unique identifier of the tag group

namestring

Name of the tag group

aliasstring

Short alias for quick tagging (max 3 characters, unique per company)

dimensionNumberinteger nullable

Dimension number for SIE file export/import compatibility.

Reserved numbers per SIE file format: 1 = Cost center, 2 = Cost carrier, 6 = Project, 7 = Employee, 8 = Customer, 9 = Supplier, 10 = Invoice, 20+ = Freely available.

Example response

{
  "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"
    }
  ]
}