Mailboxes

Get mailbox by ID

Returns a single mailbox by its unique identifier.

get/mailboxes/{id}

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/mailboxes/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: mailboxes:read)

Path parameters

idstring uuid required

Unique identifier for the mailbox

Query parameters

includestring[]

Comma-separated relations to expand inline. Valid values: user. Max 3.

Response

Successful response

idstring uuid required

Unique identifier for the mailbox

emailstring email required

Email address of the mailbox

isDefaultboolean required

Whether this is the user's default mailbox

createdAtstring date-time required

When the mailbox was created

updatedAtstring date-time required

When the mailbox was last updated

Example response

{
  "id": "bb0e8400-e29b-41d4-a716-446655440040",
  "email": "jane@acme.com",
  "isDefault": true,
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "createdAt": "2025-10-01T10:00:00.000Z",
  "updatedAt": "2025-11-15T14:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.