List Mailbox Folders

Request

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

Path Parameters

/v2/mailboxes/{mailboxId}/folders

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

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

Response fields

Path Type Description
_embedded.folders Array List of Folders

Response fields

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
↑Back to top
© Help Scout 2024