List tag groups

Returns the tag groups available to a Books instance. A tag is a label in a tag group, such as a client in a "Clients" group or a contractor in a "Contractors" group, and is applied to line entries, i.e. the debits and credits of a journal entry, through tagIds: on each line entry of bulkCreateBooksJournalEntries and bulkUpdateBooksJournalEntries, on each split of categorizeBooksTransactions, and as a filter of listBooksJournalEntries. A line entry can carry at most one tag from each group. Each tag group has its id, name, ownership, and createdAt. ownership is platform for a default group shared by every Books instance, which can't be renamed, or instance for a group that belongs to this Books instance. Results are newest first and returned a page at a time: when the response has a nextPageToken, pass it as pageToken to get the next page.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

The Books instance to act on. Must be the token organization's own instance, which it defaults to.

string

The nextPageToken or prevPageToken from a previous response, to fetch that page.

integer
1 to 1000
Defaults to 50

The maximum number of tag groups to return per page, from 1 to 1000. Defaults to 50.

Responses

400

Invalid limit or pageToken or booksId

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json