Mailboxes

List mailboxes

List mailboxes with optional domain filter and cursor-based pagination. Use the returned mailbox object's id field as mailbox_id for mailbox-scoped endpoints.

get/mailboxes

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

domain_idstring

Filter mailboxes by domain ID.

cursorstring

Opaque pagination cursor returned by the same list operation. Send it unchanged; do not parse, modify, or fabricate it.

limitinteger

Number of items to return (1-100, default 25).

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Paginated list of mailboxes.

Example response

{
  "data": [
    {
      "address": "hello@example.com"
    }
  ]
}

Changes

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