Developers
Tags5

List tags

GET/tags

Lists the user tags of the account, sorted alphabetically by name by default. Each tag includes users_count, the number of users it is assigned to. Results are paginated with limit and cursor.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Default"name"

Value in

  • "name"
  • "-name"

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/tags"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "name": "string",      "object": "tag",      "revision": "string",      "updated_at": "2019-08-24T14:15:22Z",      "users_count": 0    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Tags5

Tags in API v3: list tags, create a tag, retrieve a tag, update a tag, delete a tag.

Create a tag POST

Creates a tag that can be assigned to users. Leading and trailing whitespace is removed from the name. Tag names must be unique within the account; if the name is already in use, the API returns `409 Conflict` with the `already_exists` error code.