API Reference

Tags

Tags are workspace labels used to classify transactions, journal entries, invoices, bills, and other records. Tag groups organize related tags — each tag may belong to at most one group.

Last updated 2026-06-21

The Tags API covers both individual tags and tag groups. Tags are simple name labels; tag groups bundle tags under a named, optionally colored container for structured reporting.

Partner responses expose UUIDs as `id`. When creating or updating tag groups, pass `tagUuids` (from list tags) — the server resolves UUIDs to internal ids. A tag can belong to at most one group at a time.

Key concepts

Tags vs tag groups

Tags are flat labels. Tag groups collect tags for UI grouping and reporting. Manage tags at `/partners/tags` and groups at `/partners/tags/groups`.

One group per tag

Each tag may belong to at most one group. Assigning a tag that is already in another group returns 400.

Group membership replacement

On tag group update, sending `tagUuids` replaces the entire membership set — tags omitted are removed from the group. Pass `[]` to clear all tags.

Idempotent tag create

Creating a tag with a name that already exists returns the existing tag rather than duplicating it.

The tag object

Fields returned on a tag. Tag groups embedding the tag may appear under `tagGroups`.

Attributes

iduuid

Tag identifier (UUID).

namestring

Tag label. Required and unique per workspace on create.

tagGroupsarray

Tag groups this tag belongs to (at most one in practice).

iduuid

Tag group UUID.

namestring

Group name.

colorstring

Group color.

createdAtdatetime

ISO 8601 creation timestamp.

updatedAtdatetime

ISO 8601 last update timestamp.

Example

{
  "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
  "name": "Office",
  "tagGroups": [
    {
      "id": "f6a7b8c9-d0e1-2345-fabc-456789012346",
      "name": "Department",
      "color": "#4A90D9"
    }
  ],
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-28T14:22:30.000Z"
}

List tag groups includes ungrouped tags

GET /partners/tags/groups returns both `tagGroups` and `unGroupedTags` — tags not assigned to any group.

Deleting a tag removes associations

Deleting a tag clears its links to transactions, journal entries, invoices, bills, and other tagged records.

Recent changes

2026-06-21

Complete Partner API reference

Documented all remaining API reference groups: Chart of Accounts, Vendors, Products & Services, Recurring Invoice Templates, Credit Memos, Bills, Journal Entries, Tags, People, Projects, Tasks, Time Entries, Expense Receipts, Reports, and Workspace Stats. Added missing invoice endpoints (audit log, attachments, credit application, remove transaction) and group overviews for Invoices and Transactions.