Skip to main content
GET
List retained messages

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

page
integer<int64>
default:1

Page, 1-based.

Required range: x >= 1
limit
integer<int64>
default:50

Items per page.

Required range: 1 <= x <= 200
channelId
enum<string>

Filter by rail. Omitted returns every rail.

Available options:
spb,
pix
reason
enum<string>

Filter by retention reason.

Available options:
UNRECOGNIZED_TYPE,
ACCOUNT_UNASSIGNED,
CLASSIFICATION_FAILED,
OWNERSHIP_DECISION_UNAVAILABLE,
DELIVERY_FAILED

Response

OK

items
object[] | null
required
limit
integer<int64>
required
Required range: x >= 1
page
integer<int64>
required
Required range: x >= 1