List

Retrieve a list of all etags.

GET https://yoursite.desk.com/api/v2/etags

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

List Parameters

parameter description
endpoints Comma delimited list of endpoints to return etags for. Can be groups, labels, macros, or users.

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/etags?endpoints=users,groups \
    -u email:password \
    -H 'Accept: application/json'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
  "total_entries": 2,
  "page": 1,
  "_links": {
    "self": {
      "href": "/api/v2/etags?page=1&per_page=50",
      "class": "page"
    },
    "first": {
      "href": "/api/v2/etags?page=1&per_page=50",
      "class": "page"
    },
    "last": {
      "href": "/api/v2/etags?page=1&per_page=50",
      "class": "page"
    },
    "next": null,
    "previous": null
  },
  "_embedded": {
    "entries": [
      {
        "endpoint": "users",
        "value": "1234",
        "_links": {
          "self": {
            "href": null,
            "class": "etag"
          }
        }
      },
      {
        "endpoint": "groups",
        "value": "5678",
        "_links": {
          "self": {
            "href": null,
            "class": "etag"
          }
        }
      }
    ]
  }
}