The Tag object

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

    <div class="form-group field custom-field">
        <div class="custom-field-row">
            <label class="custom-field-name">id</label>
            
              <div class="custom-field-type">integer</div>
            
            
        </div>
        <div class="custom-field-description-container">
            <div class="field-description markdown-body"><p>ID of the tag.</p></div>
        </div>
    </div>
    
    <div class="form-group field custom-field">
        <div class="custom-field-row">
            <label class="custom-field-name">decoration</label>
            
              <div class="custom-field-type">TagDecoration | null</div>
            
            
        </div>
        <div class="custom-field-description-container">
            <div class="field-description markdown-body"><p>Information related to the style of the tag.</p></div>
        </div>
    </div>
    
    <div class="form-group field custom-field">
        <div class="custom-field-row">
            <label class="custom-field-name">description</label>
            
              <div class="custom-field-type">string | null</div>
            
            
        </div>
        <div class="custom-field-description-container">
            <div class="field-description markdown-body"><p>Short description of the tag.</p></div>
        </div>
    </div>
    
    <div class="form-group field custom-field">
        <div class="custom-field-row">
            <label class="custom-field-name">name</label>
            
              <div class="custom-field-type">string</div>
            
            
        </div>
        <div class="custom-field-description-container">
            <div class="field-description markdown-body"><p>Name of the tag. Tags' names are case sensitive.</p></div>
        </div>
    </div>
    
    <div class="form-group field custom-field">
        <div class="custom-field-row">
            <label class="custom-field-name">usage</label>
            
              <div class="custom-field-type">integer</div>
            
            
        </div>
        <div class="custom-field-description-container">
            <div class="field-description markdown-body"><p>Number of tickets this tag is associated with.</p></div>
        </div>
    </div>
    
    <div class="form-group field custom-field">
        <div class="custom-field-row">
            <label class="custom-field-name">uri</label>
            
              <div class="custom-field-type">string</div>
            
            
        </div>
        <div class="custom-field-description-container">
            <div class="field-description markdown-body"><p>URI of the tag</p></div>
        </div>
    </div>
    
    <div class="form-group field custom-field">
        <div class="custom-field-row">
            <label class="custom-field-name">created_datetime</label>
            
              <div class="custom-field-type">ISO 8601 datetime</div>
            
            
        </div>
        <div class="custom-field-description-container">
            <div class="field-description markdown-body"><p>When the tag was created.</p></div>
        </div>
    </div>
    
    <div class="form-group field custom-field">
        <div class="custom-field-row">
            <label class="custom-field-name">deleted_datetime</label>
            
              <div class="custom-field-type">string | null</div>
            
            
        </div>
        <div class="custom-field-description-container">
            <div class="field-description markdown-body"><p>When the tag was deleted.</p></div>
        </div>
    </div>
    
</form>

Tag example object

{
  "id": 123456,
  "decoration": {
    "color": "#F58D86"
  },
  "description": "Mark a ticket as urgent",
  "name": "urgent",
  "usage": 123,
  "uri": "/api/tags/5/",
  "created_datetime": "2019-07-05T14:42:00.384938",
  "deleted_datetime": "2019-07-05T14:42:00.384938"
}