Skip to main content
Endpoint · GET /tags
Read-only endpoint: it returns information and changes nothing. It is not sent inside the actions array — you call it directly.
Returns the business label catalog, in alphabetical order and paginated by cursor. It excludes deleted labels and the system labels the dashboard creates by default. Use it to learn the exact name of a label before using it: the assign_label and remove_label actions identify each label by name, so it is best to read the catalog first instead of guessing the text. Parameters
  • slug — the business slug, in the path. Case-insensitive, must match the business of the token (required).
  • search — name substring, case-insensitive. Optional, 1 to 100 characters. The asterisk * works as a wildcard and matches any sequence of characters: fact*mx finds both Facturas MX and Facturación MX. The characters % and _ are matched literally.
  • cursor — opaque cursor returned by the previous page in next_cursor. Optional; omit it to request the first page. Do not reuse cursors across different endpoints: even though the format is identical, each endpoint interprets it over its own data set.
  • limit — labels per page. Optional, integer from 1 to 500, defaults to 100.
No query parameter is required: GET /tags with no query params returns the full first page.

​
Response

  • items — array of labels, each one with name and color.
  • next_cursor — cursor for the next page, to be passed as ?cursor=. It is null when has_more is false.
  • has_more — whether there are more results after this page. Repeat the call with next_cursor until it is false.

​
Example

A plain read, with no body: it asks for the catalog and changes nothing in the business.
Searching with the wildcard and asking for a smaller page:
The name returned by this query is the one you then send in the action.

​
Errors

The full catalog is in Errors. With the name in hand, the action that consumes it is Assign label or Remove label.