We're upgrading our API

On June 6th, 2019, Mailbox API 1.0 will be sunsetted, and at that time any apps using this legacy API will no longer work. Please use Mailbox API 2.0 instead.

List Mailboxes

  • REST Method: GET
  • URL: https://api.helpscout.net/v1/mailboxes.json

Request

Name Type Required Default Notes
page Int No 1  

To request subsequent pages:
https://api.helpscout.net/v1/mailboxes.json?page=2

Response

Response Name Type Notes
Header Status Int 200 if successful
Body page Int Current page that was passed in on the request
  pages Int Total number of pages available
  count Int Total number of objects available
  items Collection Collection of Mailbox objects. Folders are not returned on the Mailbox objects on this call. 
Status: 200 OK
{
    "page": 1,
    "pages": 1,
    "count": 4,
    "items": [{
        "id": 1234,
        "name": "My Mailbox",
        "slug": "47204a026903ce6d",
        "email": "help@mymailbox.com",
        "createdAt": "2012-07-23T12:34:12Z",
        "modifiedAt": "2012-07-24T20:18:33Z"
    },
    {... mailbox object ...},
    {... mailbox object ...},
    {... mailbox object ...}
    ]
}
↑Back to top
© Help Scout 2019