List tags

Returns the tags of 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, by passing tag IDs in 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 has its id, name, tagGroupId, tagGroupName, and enabled. Filter by group with tagGroupId; to find group IDs, use getBooksTagGroups. Filter by name, which is an exact match. Disabled tags are hidden unless includeDisabled=true. 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

Only return tags in this tag group. To find tag group IDs, use getBooksTagGroups.

string

Only return tags with exactly this name.

boolean

Also return disabled tags. Defaults to false.

string

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

integer
1 to 1000
Defaults to 50

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

Responses

400

Invalid limit or pageToken or includeDisabled or name or tagGroupId 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