v1

latestOpenAPI 3.0.22026-07-144652931.4 MB

List tags

List all of your account's tags.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the API Concepts Document

Scoped OAuth requires: tags.read

get/tags

Query parameters

limitinteger

The number of results per page.

offsetinteger

Offset to start pagination search results.

totalboolean

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated.

See our Pagination Docs for more information.

querystring

Filters the result, showing only the tags whose label matches the query.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

An array of tags names.

offsetinteger

Echoes offset pagination property.

limitinteger

Echoes limit pagination property.

moreboolean

Indicates if there are additional records to return

totalinteger nullable

The total number of records matching the given query.

Example response

{
  "tags": [
    {
      "type": "tag",
      "label": "Batman"
    }
  ]
}