List Mailbox Folders

Request

GET /v2/mailboxes/1/folders HTTP/1.1
Authorization: Bearer oauth_token

Response

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

{
  "_embedded" : {
    "folders" : [ {
      "id" : 1234,
      "name" : "My Tickets",
      "type" : "mytickets",
      "userId" : 4532,
      "totalCount" : 2,
      "activeCount" : 1,
      "updatedAt" : "2012-07-24T20:18:33Z"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 1
  }
}

Response fields

Path Type Description
_embedded.folders Array List of Folders

Folders

Path Type Description
[].id Number Unique identifier
[].type String Folder type
[].name String Folder name
[].totalCount Number Total number of conversations in the folder
[].userId Number ID of the folder’s owner
[].activeCount Number Number of active tickets in the folder
[].updatedAt String When this folder was updated