Inbox

List all inbox messages for the account

Returns emails across every mailbox on the account, sorted by received time descending, served from the DynamoDB cache. Supports cursor-based pagination plus optional date-range, single-mailbox, and warmup-exclusion filters applied server-side.

Pagination is cursor-based only. page, offset and sort are not supported and are ignored: read pagination.cursor from the response and pass it back as cursor to get the next page. pagination is present on every 200 response.

When called with an API token, the first page of a read also kicks off an inbox sync in the background (at most once every 10 minutes per account), so a polling integration keeps seeing new mail without calling POST /v1/inbox/refresh itself. The sync is asynchronous — new messages land in the cache within a minute or two and appear on a later poll, not in the response that triggered it. Requests that pass a cursor never trigger a sync.

get/v1/inbox

Request

  • Base URL: https://api.winnr.app
  • URL: https://api.winnr.app/v1/inbox
  • Auth: HTTP bearer

Query parameters

limitinteger
cursorstring

Opaque cursor returned by the previous page.

date_fromstring date

Inclusive start of the date range (YYYY-MM-DD).

date_tostring date

Inclusive end of the date range (YYYY-MM-DD), through end of day.

mailboxstring

Filter to a single mailbox email address.

exclude_warmupboolean

If true, exclude emails matching the account's warmup phrases.

has_attachmentsboolean

If true, only return emails flagged as having attachments.

Response

Page of inbox messages

Changes

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