New Ory Agent Security is now live! Claim your complimentary test drive. Get Started!

Skip to main content

List Messages

GET 

/admin/courier/messages

Lists all messages by given status and recipient.

SDK ReferenceTypeScript
listCourierMessages()
ParametersTypeRequiredDescription
pageSizenumberoptionalItems per Page This is the number of items per page to return. For details on pagination please head over to the pagination documentation.
pageTokenstringoptionalNext Page Token The next page token. For details on pagination please head over to the pagination documentation.
statusCourierMessageStatusoptionalStatus filters out messages based on status. If no value is provided, it doesn't take effect on filter.
recipientstringoptionalRecipient filters out messages based on recipient. If no value is provided, it doesn't take effect on filter.
VariableType
dataArray<Message>