Email Logs

Email logs

List and retrieve email sending logs for the account.

List email logs

get

Returns a paginated list of email logs (messages) for the account. Results are restricted to sending domains the authenticated token has access to. Invalid or unknown filters are ignored. Results are ordered by sent_at descending.

Authorizations
Api-TokenstringRequired

API token in Api-Token header

Path parameters
account_idintegerRequired

Account ID

Example: 1
Query parameters
search_afterstring · uuidOptional

Cursor for the next page (message_id UUID from previous response next_page_cursor).

Responses
chevron-right
200

Success

application/json
total_countintegerRequired

Total number of messages matching the filters (before pagination).

next_page_cursorstring · uuid · nullableRequired

Message UUID to use as search_after for the next page. Null if no more pages.

get
/api/accounts/{account_id}/email_logs
cURL

Get an email log message by ID

get

Returns a single message by message UUID. Message must belong to the account and a sending domain the token can access.

Authorizations
Api-TokenstringRequired

API token in Api-Token header

Path parameters
account_idintegerRequired

Account ID

Example: 1
sending_message_idstring · uuidRequired

Message UUID

Responses
chevron-right
200

Success

application/json
message_idstring · uuidOptional
statusstring · enumOptionalPossible values:
subjectstring · nullableOptional
fromstringOptional
tostringOptional
sent_atstring · date-timeOptional
client_ipstring · nullableOptional
categorystring · nullableOptional
custom_variablesobjectOptional
sending_streamstring · enumOptionalPossible values:
sending_domain_idintegerOptional
template_idinteger · nullableOptional
template_variablesobjectOptional
opens_countintegerOptional
clicks_countintegerOptional
raw_message_urlstring · uriOptional

Signed URL to download raw .eml message (temporary).

get
/api/accounts/{account_id}/email_logs/{sending_message_id}
cURL

Last updated

Was this helpful?