GET
List notifications

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

status
enum<string>

Filter by delivery state. failed means the row exhausted its attempts or was cancelled, not that one attempt errored. An unrecognised value is a 400 rather than an empty page: "no message is in that state" and "there is no such state" are different facts, and a client told the former concludes the store's mail is going out.

Available options:
failed,
pending,
sent
event_key
string

Restrict the page to one event, such as order.confirmation, which answers "did the receipts go out" without a second route.

limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object