List tag groups

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/tag_groups \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "tag_group",
      "data": {
        "label": "Department",
        "label_translations": null,
        "label_translated": "Department",
        "description": null,
        "description_translations": null,
        "description_translated": null,
        "color": null,
        "archived_at": null,
        "is_deletable": true,
        "is_component_locked": false,
        "is_journal_entry_dimension": false,
        "integrations": {
          "xero": {
            "id": null,
            "type": null
          },
          "quickbooks": {
            "type": null
          }
        },
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tag_groups/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "tag_group",
      "data": {
        "label": "Department",
        "label_translations": null,
        "label_translated": "Department",
        "description": null,
        "description_translations": null,
        "description_translated": null,
        "color": null,
        "archived_at": null,
        "is_deletable": true,
        "is_component_locked": false,
        "is_journal_entry_dimension": false,
        "integrations": {
          "xero": {
            "id": null,
            "type": null
          },
          "quickbooks": {
            "type": null
          }
        },
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tag_groups/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "tag_group",
      "data": {
        "label": "Department",
        "label_translations": null,
        "label_translated": "Department",
        "description": null,
        "description_translations": null,
        "description_translated": null,
        "color": null,
        "archived_at": null,
        "is_deletable": true,
        "is_component_locked": false,
        "is_journal_entry_dimension": false,
        "integrations": {
          "xero": {
            "id": null,
            "type": null
          },
          "quickbooks": {
            "type": null
          }
        },
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tag_groups/<id>"
      }
    }
  ],
  "links": {
    "first": "/tag_groups?business_entity_id=<id>&page=1",
    "last": "/tag_groups?business_entity_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 3,
    "has_more": false
  }
}

GET

tag_groups

List tag groups

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/tag_groups \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "tag_group",
      "data": {
        "label": "Department",
        "label_translations": null,
        "label_translated": "Department",
        "description": null,
        "description_translations": null,
        "description_translated": null,
        "color": null,
        "archived_at": null,
        "is_deletable": true,
        "is_component_locked": false,
        "is_journal_entry_dimension": false,
        "integrations": {
          "xero": {
            "id": null,
            "type": null
          },
          "quickbooks": {
            "type": null
          }
        },
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tag_groups/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "tag_group",
      "data": {
        "label": "Department",
        "label_translations": null,
        "label_translated": "Department",
        "description": null,
        "description_translations": null,
        "description_translated": null,
        "color": null,
        "archived_at": null,
        "is_deletable": true,
        "is_component_locked": false,
        "is_journal_entry_dimension": false,
        "integrations": {
          "xero": {
            "id": null,
            "type": null
          },
          "quickbooks": {
            "type": null
          }
        },
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tag_groups/<id>"
      }
    },
    {
      "id": "<id>",
      "object": "tag_group",
      "data": {
        "label": "Department",
        "label_translations": null,
        "label_translated": "Department",
        "description": null,
        "description_translations": null,
        "description_translated": null,
        "color": null,
        "archived_at": null,
        "is_deletable": true,
        "is_component_locked": false,
        "is_journal_entry_dimension": false,
        "integrations": {
          "xero": {
            "id": null,
            "type": null
          },
          "quickbooks": {
            "type": null
          }
        },
        "business_entity": {
          "id": "<id>",
          "object": "business_entity",
          "links": {
            "self": "/business_entities/<id>"
          }
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/tag_groups/<id>"
      }
    }
  ],
  "links": {
    "first": "/tag_groups?business_entity_id=<id>&page=1",
    "last": "/tag_groups?business_entity_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 3,
    "has_more": false
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

business_entity_id

string

required

include_archived

boolean

archived_at

object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: archived_at=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

gt (greater than)
gte (greater than or equal to)
lte (less than or equal to)
lt (less than) Example: archived_at[gte]=2024-01-01&archived_at[lt]=2024-12-31

expand

enum<string>[]

Available options:

tags

Response

200 - application/json

object

string

read-only

The type of the object in Nmbr ("list").

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

The type of the object in Nmbr ("tag_group").

data.data

Default · object

Default
With tags expanded

Hide child attributes

data.data.label

string

Maximum string length: 255

data.data.label_translations

object

Optional translations for the label property.

Hide child attributes

data.data.label_translations.en

string

Maximum string length: 255

data.data.label_translations.fr

string

Maximum string length: 255

data.data.label_translated

string

read-only

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.

data.data.description

string | null

data.data.description_translations

object

Optional translations for the description property.

Hide child attributes

data.data.description_translations.en

string

Maximum string length: 255

data.data.description_translations.fr

string

Maximum string length: 255

data.data.description_translated

string

read-only

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.

data.data.color

string | null

A hex colour code for the tag group (e.g. #AABBCC or #ABC). Used for display.

Maximum string length: 7

data.data.archived_at

string<dateTime> | null

read-only

When set, the tag group is archived and excluded from index listings by default.

data.data.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.

data.data.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.

data.data.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.

data.data.integrations

object

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.

Hide child attributes

data.data.integrations.xero

object

Hide child attributes

data.data.integrations.xero.id

string

read-only

The unique identifier of the object in Nmbr.

Maximum string length: 32

data.data.integrations.xero.type

any

data.data.integrations.quickbooks

object

Hide child attributes

data.data.integrations.quickbooks.type

any

data.data.business_entity

object

Hide child attributes

data.data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.business_entity.object

string

read-only

The type of the object in Nmbr ("business_entity").

data.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

Delete an accounting code rule Create a tag group

⌘I