get_bounce | Retrieve one bounce: type, email, details, dates, whether it can be reactivated (CanActivate). |
get_bounces_stats | Bounce counts per day and per type (hard, soft, transient, SMTP API errors) for a period. |
get_message_opens | List the open events of one sent message (date, client, OS, platform, geography). The full delivery timeline is in get_outbound_message (MessageEvents). |
get_opens_stats | Open counts per day (total and unique) for a period. |
get_outbound_message | Retrieve one sent message with its text and HTML bodies and its MessageEvents (Delivered, Transient, Opened, LinkClicked, Bounced, SubscriptionChanged). |
get_outbound_stats | Outbound overview for a period: sent, bounced, bounce rate, spam complaints, tracked and unique opens, link clicks. |
get_server | Retrieve the Postmark server this token belongs to (name, ID, tracking settings, inbound address). Cheapest call to check the token. |
get_template | Retrieve one template (subject, HTML and text bodies, layout, alias) by numeric ID or alias. |
list_bounces | List bounces (ID, type, email, date, whether it can be reactivated). type: e.g. HardBounce, SoftBounce, Transient, SpamComplaint, Blocked, AutoResponder. inactive: true for deactivated addresses only. email_filter, tag, message_id, from_date / to_date (Eastern Time, e.g. 2026-09-01T12:00:00), message_stream (default “outbound”). |
list_inbound_messages | Search messages received by the server inbound address. Filters: recipient, from_email, tag, subject, mailbox_hash, status (blocked, processed, queued, failed, scheduled), from_date / to_date (e.g. 2026-09-01T12:00:00). |
list_outbound_messages | Search sent messages (newest first): MessageID, recipients, subject, tag, status, stream, received date. Filters: recipient, from_email, tag, subject, status (queued, sent or processed), from_date / to_date (e.g. 2026-09-01T12:00:00), message_stream. |
list_suppressions | List the suppressed recipients of a message stream (email, reason, origin, date). suppression_reason: HardBounce, SpamComplaint or ManualSuppression. origin: Recipient, Customer or Admin. from_date / to_date: YYYY-MM-DD. |
list_templates | List the templates of the server (ID, alias, name, type, active). template_type: All (default), Standard or Layout. layout_template: keep only templates using this layout alias. |