GET/tags/{tag_id}

Get a tag

Retrieves a tag by its identifier from the workspace. Use the tag_id path parameter to specify which tag to retrieve.

2 parameters
tag_idstringrequired
The unique identifier of the tag to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the tag object, including its identifier and name.
typestringoptional
value is "tag"
idstringoptional
The id of the tag
namestringoptional
The name of the tag
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when no tag exists with the given identifier.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when no tag exists with the given tag_id path parameter. The Intercom-Version header selects the API version and defaults to 2.17 when omitted.