Appearance

List Tags ​

Endpoint ​

http
GET /unified/ticketing/tags
Integrations supported
  • Asana
  • Azure DevOps
  • ClickUp
  • Dixa
  • Enchant
  • Front
  • FuseDesk
  • GitLab
  • Gorgias
  • Help Scout
  • Hive
  • Jira
  • Kustomer
  • Linear
  • LiveAgent
  • Missive
  • Pivotal Tracker
  • Quickbase for Project Management
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Trengo
  • YouTrack
  • Zoho Projects

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_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
name
string

The name of the tag

Supported in
  • Gorgias
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • name
Supported in
  • Gorgias
  • Teamwork Project Management
created_at
string · date-time

The date the tag was created

All possible enum values:
  • asc
  • desc
Supported in
  • Gorgias
name
string

The name of the tag

All possible enum values:
  • asc
  • desc
Supported in
  • Gorgias
workspace_id
Supported in
  • Asana
space_id
string

The ClickUp Space ID. Refer https://clickup.com/api/clickupreference/operation/GetSpaceTags for more details

Required in
  • ClickUp
workspace
object

Workspace for which the labels are to be fetched

Required in
  • GitLab
  • Trello
Supported in
  • Teamwork Project Management
id
string

The unique identifier for a workspace

name
string

The name of the workspace

organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

collections
array

Collection with type project is required.

Required in
  • Pivotal Tracker

Response Body ​

result
object[]

List of Tags

id
string

The unique identifier for a tag

Supported in
  • Asana
  • Azure DevOps
  • ClickUp
  • Dixa
  • Enchant
  • Front
  • FuseDesk
  • GitLab
  • Gorgias
  • Help Scout
  • Hive
  • Jira
  • Kustomer
  • Linear
  • LiveAgent
  • Missive
  • Pivotal Tracker
  • Quickbase for Project Management
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Trengo
  • YouTrack
  • Zoho Projects
name
string

The name of the tag

Supported in
  • Asana
  • Azure DevOps
  • ClickUp
  • Dixa
  • Enchant
  • Front
  • FuseDesk
  • GitLab
  • Gorgias
  • Help Scout
  • Hive
  • Jira
  • Kustomer
  • Linear
  • LiveAgent
  • Missive
  • Pivotal Tracker
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Trengo
  • YouTrack
  • Zoho Projects
color
string

Color of the tag. In hex format.

Supported in
  • Dixa
  • Enchant
  • Front
  • Gorgias
  • Help Scout
  • Hive
  • Kustomer
  • LiveAgent
  • Missive
  • Todoist
  • Trengo
  • Zoho Projects
workspace
object

The workspace the tag belongs to

Supported in
  • Hive
  • Missive
  • 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
  • Linear
  • Pivotal Tracker
updated_at
string · date-time

The date the tag was last updated

Supported in
  • Azure DevOps
  • Front
  • Help Scout
  • Hive
  • Kustomer
  • Linear
  • Pivotal Tracker
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
  • FuseDesk
  • Kustomer
  • LiveAgent
  • Trengo
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.