Mailboxes

List mailbox inbox thread attention states

Lists the deterministic attention queue with cursor-bound keyset pagination, anchored to the first page's message-time cutoff. Live state changes may add or remove rows; use reply-scans when a frozen historical candidate set is required. Defaults to needs_reply, oldest first.

get/mailboxes/{id}/inbox/threads

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/inbox/threads
  • 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

attention_state'needs_reply' | 'waiting_on_them' | 'done' | 'follow_up_due' | 'delivery_failed' | 'no_action'
sort_by'attention_since' | 'last_message_at'
order'asc' | 'desc'
afterstring date-time
beforestring date-time
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

Attention queue page and state counts.

object'inbox_threads' required
mailbox_idstring required
summaryobject required

Changes

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