List notification history | Perkss

Pages through the notifications sent on the company’s behalf (lifecycle and loyalty emails today). Every row is a send decision: sent, or a failed:<reason> / skipped:<reason> variant — suppressed sends are visible, not silent. Filters are exact matches (customerId, templateKey, channel, status); rendered message content is never exposed. page is 1-based; pageSize defaults to 20 and is capped at 100.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pagestringOptional

1-based page number. Defaults to 1.

pageSizestringOptional

Rows per page. Defaults to 20, capped at 100.

customerIdstringOptional

Filter to one customer's send history.

templateKeystringOptional

Filter by notification kind, e.g. ‘lifecycle.birthday’ or ‘loyalty.reward-unlocked’.

channelstringOptional

Filter by delivery channel, e.g. 'email'.

statusstringOptional

Filter by send decision: ‘sent’ or a ‘failed:<reason>’ / ‘skipped:<reason>’ variant.

Response

totaldouble

Total row count after server-side filtering — drives total-page math.

pagedouble

1-based page number that produced items.

pageSizedouble

Page size honored by the server (may be a clamp of the requested value).

itemslist of objects

The history rows on this page.

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

503

Service Unavailable Error