List Email Logs
Beta/v1/core/email-logsThis endpoint is idempotent. Learn more
Returns a paginated list of email logs for the current account.
cursoroptional stringQuery parameter: cursor for List Email Logs
limitoptional integerQuery parameter: limit for List Email Logs
qoptional stringQuery parameter: q for List Email Logs
include[]optional arrayenumValues:sent_bySub-objects to expand in the response. When omitted, sub-objects are returned as null.
objectstringenumValues:listObject type for EmailLog list
page_infoobjectPagination metadata for EmailLog list
next_cursorstringnullableCursor to fetch the next page, null if no more pages.
prev_cursorstringnullableCursor to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectArray of EmailLog resources in this page
idstringEmail log ID.
objectstringenumValues:email_logResource type identifier.
has_sentbooleanWhether the email was sent.
recipientsarray of stringRecipient email addresses.
subjectstringnullableEmail subject line.
filenamestringnullableFilename of any attachment.
ses_message_idstringnullableSES message ID returned by AWS.
sent_byobjectExpandablenullableActor who sent the email. Null when the email was sent by the
system, or when the caller did not request include=sent_by.
idstringActor ID.
objectstringenumValues:actorResource type identifier.
typestringenumValues:userapi_keyagentActor type.
namestringnullableDisplay name.
handlestringnullableHuman-readable handle (email for users, redacted value for API keys, slug for agents).
roleobjectnullableAssigned role.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Responses
Successful response for List Email Logs