List messages

GET

Fetch the statuses of messages you’ve previously sent.

Query parameters

archivedbooleanOptional

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

cursorstringOptional

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

eventstringOptional

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

liststringOptional

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

messageIdstringOptionalDeprecated

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

notificationstringOptional

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

providerstringOptional

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.

recipientstringOptional

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

statusstringOptional

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

tagstringOptional

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

tagsstringOptionalDeprecated

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

tenant_idstringOptional

Messages sent with the context of a Tenant

enqueued_afterstringOptional

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

traceIdstringOptionalDeprecated

The unique identifier used to trace the requests

Response

This endpoint returns an object.
pagingobject

Paging information for the result set.

resultslist of objects

An array of messages with their details.

Built with