GET
/
v0
/
tags
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "enabled": true,
      "id": "UjL3BQnEaJtecuC7CUeDk",
      "name": "Sprinter - 1ab-c23",
      "tag_group_id": "NCB2xo5S1yQbNgyWskXpwG",
      "tag_group_name": "Delivery vehicles"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

The teal instance ID

Query Parameters

name
string | null

Optional name of tag for filtering.

tag_group_id
string | null

Optional tag group ID for filtering.

include_disabled
boolean
default: false

Include disabled tags.

sort
enum<string>[] | null

The sort order of the results.

Available options:
name,
-name,
enabled,
-enabled
limit
integer | null

The number of records to return. Max limit is 1000.

page_token
string

Response

200 - application/json
next_page_token
string | null
required

The token to use to request the next page

prev_page_token
string | null
required

The token to use to request the previous page

records
object[]
required

A list of tags.