Skip to main content
GET
/
v0
/
tags
/
{tag_id}
Retrieve a tag
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/tags/{tag_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "id": "<string>",
  "name": "<string>",
  "tag_group_id": "<string>",
  "tag_group_name": "<string>",
  "enabled": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
teal-instance-id
string
required

The teal instance ID

Path Parameters

​
tag_id
string
required

The tag ID

Response

Successful Response

​
id
string
required

The unique ID of the object.

Example:

"UjL3BQnEaJtecuC7CUeDk"

​
name
string
required

An arbitrary string, useful for identifying the tag to the user.

Example:

"Sprinter - 1ab-c23"

​
tag_group_id
string
required

The ID of the tag group.

Example:

"NCB2xo5S1yQbNgyWskXpwG"

​
tag_group_name
string
required

An arbitrary string, useful for identifying the tag group to the user.

Example:

"Delivery vehicles"

​
enabled
boolean
required

Whether the tag is able to be assigned to objects.

Example:

true