mail-messages

Stable. Describes behaviour that is built and covered by tests in this repository.

GET `/v1/mail-messages` #

The tenant's recent mail, newest first

The mail the notifier sent for the tenant's customers with what became of each: sending, sent, and what the provider reported (delivered, delayed, bounced for good, soft_bounced, complained). Mail without a tenant (Payrudder's own) is not in it. A page at a time (page_size 1 to 500, default 50). On a deployment whose gateway is not connected to the notifier the answer is 200 with an empty list and connected false.

Parameters

Name	In	Type	Description
`page_size`	query	integer
`page_token`	query	string

Responses

Status	Meaning	Body
`200`	OK	ListMailMessagesResponse
`400`	Error envelope	Error
`503`	Error envelope	Error

Example response

{
  "messages": [
    {
      "key": "string",
      "kind": "string",
      "template": "string",
      "recipient": "string",
      "state": "sending",
      "claim_time": "2026-11-03T10:15:00Z",
      "send_time": "2026-11-03T10:15:00Z"
    }
  ],
  "next_page_token": "string",
  "connected": false
}

curl

curl -X GET https://YOUR-API-ADDRESS/v1/mail-messages \
  -H "Authorization: Bearer $PAYRUDDER_API_KEY"

Models

Error

Field	Type	Description
`error` required	object

ListMailMessagesResponse

Field	Type	Description
`messages` required	array of MailMessage
`next_page_token` required	string
`connected` required	boolean	False when this deployment's gateway is not connected to the notifier (the log is then empty because nothing was asked, not because no mail was sent).

MailMessage

Field	Type	Description
`key` required	string	The notifier's key for the mail (one mail has one key, however often it was asked for).
`kind` required	string	What asked for it: command, limit, trial, price_change, contract, renewal or withdrawal.
`template` required	string
`recipient` required	string
`state` required	`sending` \| `sent` \| `delivered` \| `delayed` \| `bounced` \| `soft_bounced` \| `complained`
`claim_time` required	string · date-time
`send_time` required	string · date-time