Appearance

Get Tags ​

Endpoint ​

http
GET /unified/ticketing/tags/{id}
Integrations supported
  • Asana
  • Azure DevOps
  • Dixa
  • eDesk
  • Front
  • Gorgias
  • Help Scout
  • Hive
  • Kustomer
  • LiveAgent
  • Pivotal Tracker
  • Quickbase for Project Management
  • ServiceNow
  • Superchat
  • Teamwork Project Management
  • Todoist
  • Trello
  • Trengo

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
collections
array

Collection with type project is required.

Required in
  • Pivotal Tracker

Response Body ​

id
string

The unique identifier for a tag

Supported in
  • Asana
  • Azure DevOps
  • Dixa
  • eDesk
  • Front
  • Gorgias
  • Help Scout
  • Hive
  • Kustomer
  • LiveAgent
  • Pivotal Tracker
  • Quickbase for Project Management
  • ServiceNow
  • Superchat
  • Teamwork Project Management
  • Todoist
  • Trello
  • Trengo
name
string

The name of the tag

Supported in
  • Asana
  • Azure DevOps
  • Dixa
  • eDesk
  • Front
  • Gorgias
  • Help Scout
  • Hive
  • Kustomer
  • LiveAgent
  • Pivotal Tracker
  • ServiceNow
  • Superchat
  • Teamwork Project Management
  • Todoist
  • Trello
  • Trengo
color
string

Color of the tag. In hex format.

Supported in
  • Dixa
  • eDesk
  • Front
  • Gorgias
  • Help Scout
  • Hive
  • Kustomer
  • LiveAgent
  • ServiceNow
  • Todoist
  • Trengo
workspace
object

The workspace the tag belongs to

References: Workspaces → id
Supported in
  • Front
  • Hive
  • Teamwork Project Management
  • Trello
id
string

The unique identifier for a workspace

name
string

The name of the workspace

created_at
string · date-time

The date the tag was created

Supported in
  • Asana
  • Front
  • Gorgias
  • Help Scout
  • Hive
  • Kustomer
  • Pivotal Tracker
  • ServiceNow
updated_at
string · date-time

The date the tag was last updated

Supported in
  • Azure DevOps
  • Front
  • Help Scout
  • Hive
  • Kustomer
  • Pivotal Tracker
  • ServiceNow
etag
string

The unique identifier for the specific version of the resource.

status
string

The status of the tag. If no clear mapping is available, then the raw value is returned.

All possible enum values:
  • active
  • inactive
Supported in
  • Dixa
  • eDesk
  • Kustomer
  • LiveAgent
  • ServiceNow
  • Trengo
parent
object

The parent tag of this tag

References: Tags → id
Supported in
  • Front
id
string

The unique identifier for the tag

remote_data
object

Raw data returned from the remote API call.