A tag is used to group tickets sharing one or several characteristics to easily retrieve them.Tags are used in views, rules and in statistics to filter out specific tickets.
For example, you can have an view named urgent that displays all tickets that have an urgent tag and that should be handled before any other tickets.

Tag properties

int32

ID of the object

created_datetime

ISO 8601 datetime

When the tag was created.

decoration

object

Information related to the style of the tag (e.g. the color of the tag).

deleted_datetime

ISO 8601 datetime

When the tag was deleted.

description

string

Short description of the tag.

name

string

Name of the tag. Tags' names are case sensitive.

usage

int32

Number of tickets this tag is associated with.

uri

string

URI of the object (auto-generated)

Tag example object

{
  "created_datetime": "2020-07-1300:00:00-05:00",
  "decoration": {
    "color": "#0693E3"
  },
  "deleted_datetime": "2020-07-1500:00:00-05:00",
  "description": "Mark a ticket as urgent",
  "name": "urgent",
  "usage": 123
}