Skip to main content
GET
List Retained TED IN Messages

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Query Parameters

reason
enum<string>

Filter by retention reason.

Available options:
UNRECOGNIZED_TYPE,
ACCOUNT_NOT_OWNED,
ACCOUNT_UNASSIGNED,
RECIPIENT_NOT_FOUND_RETURN_UNAUTHORIZED,
CLASSIFICATION_FAILED,
AMBIGUOUS_CONTROL_ID,
LEDGER_ROUTE_UNRESOLVED,
RECIPIENT_AMBIGUOUS_ORGANIZATIONS,
OWNERSHIP_DECISION_UNAVAILABLE
state
enum<string>
default:open

Closure window. open (default) is what is still stuck and what every retained gauge counts; closed is what an operator already settled, with who, when, and how; all is both.

Available options:
open,
closed,
all
limit
integer
default:50

Maximum number of records to return.

Required range: 1 <= x <= 200
offset
integer
default:0

Number of records to skip for pagination. Advance it by the returned value of the previous page.

Required range: x >= 0

Response

Indicates that the request was successful and the matching retained messages are returned.

items
object[]
pagination
object