Sign in

v1

latestOpenAPI 3.1.02026-08-066378446.6 KB
Account

List tags

<small>Requires an API token with one of the following roles: Document Reader, Template Reader, or Tag Manager.</small>

Lists the tags defined for your account.

Tags are simple labels that can be assigned to documents and templates.

Sorting

To specify the order that tags should be returned in, use the sort_by and sort_direction query string parameters.

For example, to sort by the name attribute in descending order, the query string should contain: sort_by=name&sort_direction=desc

get/tags

Query parameters

sort_by'name' nullable

Name of the field to sort the response by. Default is name

sort_direction'asc' | 'desc' nullable

Default is asc

pageinteger nullable
per_pageinteger nullable

Response

Paginated set of TagResource

Example response

{
  "data": [
    {
      "uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
      "name": "Warranty",
      "color": "#615fff"
    }
  ]
}