Messages

List messages

List messages with cursor-based pagination. Provide mailbox_id, client_reference, or both. client_reference lookup is exact and organization-scoped.

get/messages

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/messages
  • 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

mailbox_idstring

Filter messages by mailbox ID. Use the id field returned by GET /mailboxes.

client_referencestring

Caller-defined correlation reference, unique within an organization and mode. Sending again from the same mailbox with a reference already in use returns the original message (201) and sends nothing; the new body is not compared. The same reference from a different mailbox returns 409.

Exact caller-defined reference. At least one of mailbox_id or client_reference is required.

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 messages.

Changes

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