HomeTutorialsAPI ReferenceStatus
API Reference

Retrieve Messages

get
https://{APP_DOMAIN}/api/3.2/messages

Returns a paginated list of sent and scheduled email/SMS messages with their delivery status. Conditionally loads related models based on requested columns. Supports aggregate statistics when the aggregates parameter is included.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Filter by message ID

integer

Filter by publication ID

integer

Filter by message type ID

boolean

Filter by test/live status

integer

Filter by resource/article ID

string

Filter by creation date. Supports operators: >, >=, <, <=

string

Filter by scheduled send date. Supports operators: >, >=, <, <=

boolean

Include aggregate statistics (totals and averages) in the response

columns[]
array of strings

The field names to be included in the JSON response. You can have multiple columns[] query params included in the request URL (e.g. columns[]=id&columns[]=name).

columns[]
integer

The page to return.

integer

The total results to return per page.

string

The field to sort the request by. column_name|asc OR desc

Response

Updated 28 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 28 days ago