Skip to main content
GET
List tags

Authorizations

X-API-Key
string
header
required

Your organization API key. See Authentication.

Query Parameters

tag_ids
string[]

IDs to return, separated by commas. The other filters also apply.

Required array length: 1 - 100 elements
Minimum string length: 1
include_count
boolean

Include the total number of matching records. If the count cannot be calculated, the request fails.

sort_by
enum<string>

Field to sort by. Defaults to created_at. Use created_at to page through all tags. With updated_at, a tag that changes during paging can be skipped.

Available options:
created_at,
updated_at
sort_direction
enum<string>

Sort direction. Defaults to desc (newest first).

Available options:
asc,
desc
limit
integer
default:50

Maximum number of records to return.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page. Keep the other filters unchanged.

status
enum<string>

Usable or retained for history.

Available options:
active,
archived

Case-insensitive search in labels and descriptions.

key
enum<string>

Tag key. Must be one of the listed values. Other values return HTTP 400.

Available options:
Customer,
Supplier,
System,
ID,
Bank Account,
Cost Center,
Class,
Staff,
Product,
Workflow,
Review Status,
Custom
value
string

Tag value search.

Response

The matching records.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.

total_count
integer

Total matching records across all pages. Present when include_count=true.

Required range: x >= 0