List Tags

Returns a list of tags used across all mailboxes. Tags are returned in alphabetical order.

Request

GET /v2/tags HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Description
page Page number

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8

{
  "_embedded" : {
    "tags" : [ {
      "id" : 123456793,
      "slug" : "dark-side",
      "name" : "Dark Side",
      "color" : "green",
      "createdAt" : "2010-02-10T09:00:00Z",
      "ticketCount" : 5
    }, {
      "id" : 123456794,
      "slug" : "the-other-side",
      "name" : "The other side",
      "color" : "green",
      "createdAt" : "2010-02-10T09:00:00Z",
      "updatedAt" : "2010-02-10T10:37:00Z",
      "ticketCount" : 2
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "page" : {
      "href" : "...",
      "templated" : true
    },
    "self" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 1
  }
}

Response fields

Path Type Description
_embedded.tags Array Array of tags

Tag object

Path Type Description
[].id Number Unique tag identifier
[].name String Tag name as seen in the web application
[].slug String Slugified version of the tag value
[].ticketCount Number Number of tickets tagged by this tag
[].color String Tag color
[].createdAt String Time when the tag was created
[].updatedAt String Time when the tag was updated