v53

OpenAPI 3.0.1raw.githubusercontent.com2026-07-31147343479.6 KB
Messages

List messages

Returns previously sent messages, most recent first, each carrying its status, recipient, channel, and provider. Paged by cursor.

get/messages

Query parameters

archivedboolean nullable

A boolean value that indicates whether archived messages should be included in the response.

cursorstring nullable

A unique identifier that allows for fetching the next set of messages.

eventstring nullable

A unique identifier representing the event that was used to send the event.

liststring nullable

A unique identifier representing the list the message was sent to.

messageIdstring nullable

A unique identifier representing the message_id returned from either /send or /send/list.

notificationstring nullable

A unique identifier representing the notification that was used to send the event.

providerstring[]

The key assocated to the provider you want to filter on. E.g., sendgrid, inbox, twilio, slack, msteams, etc. Allows multiple values to be set in query parameters.

recipientstring nullable

A unique identifier representing the recipient associated with the requested profile.

statusstring[]

An indicator of the current status of the message. Allows multiple values to be set in query parameters.

tagstring[]

A tag placed in the metadata.tags during a notification send. Allows multiple values to be set in query parameters.

tagsstring nullable

A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.

tenant_idstring nullable

Messages sent with the context of a Tenant

enqueued_afterstring nullable

The enqueued datetime of a message to filter out messages received before.

traceIdstring nullable

The unique identifier used to trace the requests

Response