---
title: "List tag groups"
method: GET
path: "/tag_groups"
tags: ["Tag Groups"]
---

# List tag groups

`GET /tag_groups`

## Query parameters

- `business_entity_id` string, required
- `include_archived` boolean
- `archived_at` object
- `expand` string[]

## Response `200`

OK

- object
  - `object` string — The type of the object in Nmbr (`"list"`).
  - `data` object[]
    - `id` string — The unique identifier of the object in Nmbr.
    - `object` string — The type of the object in Nmbr (`"tag_group"`).
    - `data` TagGroup
      - `label` string
      - `label_translations` Translations, nullable
        - `en` string
        - `fr` string
      - `label_translated` string — The translation of the `label` property for the request locale. Computed using the values in `label` and `label_translations` and the value of the request's `Accept-Language` header.
      - `description` string, nullable
      - `description_translations` Translations, nullable
        - `en` string
        - `fr` string
      - `description_translated` string — The translation of the `description` property for the request locale. Computed using the values in `description` and `description_translations` and the value of the request's `Accept-Language` header.
      - `color` string, nullable — A hex colour code for the tag group (e.g. `#AABBCC` or `#ABC`). Used for display.
      - `archived_at` string, dateTime, nullable — When set, the tag group is archived and excluded from index listings by default.
      - `is_deletable` boolean — A tag group may not be deleted while it is the primary tag group or any of its tags are assigned to active allocations.
      - `is_component_locked` boolean — When `true`, the tags within this group cannot be modified through the embedded portal. Tags can still be managed through the API.
      - `is_journal_entry_dimension` boolean — When `true`, this tag group is used as a dimension in journal entry reports. A business entity can have up to three journal entry dimensions.
      - `integrations` object, nullable — Identifiers and object types for this tag group in external accounting integrations, used to sync tag groups imported from those systems. QuickBooks does not expose a group-level identifier, so only the type is stored for QuickBooks.
        - `xero` object, nullable
          - `id` string — The unique identifier of the object in Nmbr.
          - `type` unknown
        - `quickbooks` object, nullable
          - `type` unknown
      - `business_entity` object
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"business_entity"`).
      - `created_at` string, dateTime — The date and time the object was created in Nmbr.
      - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

## Changes

> 18 revisions in range; 14 could not be searched.

- **2026-07-31** `7c45252e3e56` — 2 info
  - added the optional property `data/items/data/anyOf[subschema #2: With tags expanded]/tags/data/items/data/expense_template_code` to the response with the `200` status
  - added the optional property `data/items/data/anyOf[subschema #2: With tags expanded]/tags/data/items/data/liability_template_code` to the response with the `200` status

[Change history](https://skmtc.dev/nmbr/apis/nmbr-api/changes/tag_groups/get.md)

---

[API](https://skmtc.dev/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.dev/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/revisions/29c2d6ac7131/schema)