Get Inbox

Request

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

Path Parameters

/v2/mailboxes/{mailboxId}

Response

HTTP/1.1 200 OK
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 Inbox
slug String Key used to represent this Inbox
email String Email address
createdAt String UTC time when this inbox was created.
updatedAt String UTC time when this inbox was modified.
Relation Description
folders Inbox folders
fields Inbox custom fields
↑Back to top
© Help Scout 2024