v1

latestSwagger 2.02026-07-13434569.6 KB
Messages API

Inbound message search

get/messages/inbound

Query parameters

countinteger required

Number of messages to return per request. Max 500.

offsetinteger required

Number of messages to skip

recipientstring email

Filter by the user who was receiving the email

fromemailstring email

Filter by the sender email address

subjectstring

Filter by email subject

mailboxhashstring

Filter by mailboxhash

tagstring

Filter by tag

status'blocked' | 'processed' | 'queued' | 'failed' | 'scheduled'

Filter by status (blocked, processed, queued, failed, scheduled)

todatestring date

Filter messages up to the date specified. e.g. 2014-02-01

fromdatestring date

Filter messages starting from the date specified. e.g. 2014-02-01

Headers

X-Postmark-Server-Tokenstring required

The token associated with the Server on which this request will operate.

Response

OK

TotalCountinteger