Skip to main content
POST
Retrieve tags in aggregated format

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Query Parameters

company_id
string<uuid>

Unique identifier of the company whose tags you are searching for.

before
string

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

after
string

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

offset
integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after]).

limit
integer<int32>

The maximum amount of items to return.

sorting_keys
string[]

The keys to sort the results by.

sorting_order
enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Available options:
ASC,
ASC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC,
DESC_NULLS_FIRST,
DESC_NULLS_LAST

Body

application/json;charset=UTF-8
archived
boolean

True if only archived tags should be returned, False if only non-archived tags should be returned. if provided, includeArchived flag will be ignored. If not provided or null, archived and non-archived tags will be returned depending on the includeArchived flag.

includeArchived
boolean

Boolean flag to determine whether archived tags should be included. If not provided, only non-archived tags will be returned.

tagGroupIds
string<uuid>[]

List of tag group IDs that you are searching for.

List of tag group IDs that you are searching for.

tagIds
string<uuid>[]

List of tag IDs that you are searching for.

List of tag IDs that you are searching for.

Free text search for tags by name.

Response

default - application/json;charset=UTF-8

default response

data
object[]
required
pagination
object
required