Get Mailbox

Request

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

Path Parameters

/v2/mailboxes/{mailboxId}

Response

HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=AA7F93336D673F24CA529819B9063A9C; Path=/; HttpOnly
Content-Type: application/hal+json

{
  "id" : 1,
  "name" : "Help Scout",
  "slug" : "83ebc5d87292a795",
  "email" : "bearbox@acme.com",
  "createdAt" : "2013-06-05T09:17:15Z",
  "updatedAt" : "2016-11-11T12:20:39Z",
  "_links" : {
    "self" : {
      "href" : "..."
    },
    "folders" : {
      "href" : "..."
    },
    "fields" : {
      "href" : "..."
    }
  }
}

Response fields

Path Type Description
id Number Unique identifier
name String Name of the Mailbox
slug String Key used to represent this Mailbox
email String Email address
createdAt String UTC time when this mailbox was created.
updatedAt String UTC time when this mailbox was modified.
Relation Description
folders Mailbox folders
fields Mailbox custom fields
↑Back to top
© Help Scout 2024