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 stringOpaque cursor token identifying where the page of results starts.
Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.
limitoptional integerMaximum number of results to return in a single page.
qoptional stringFree-text search term used to filter results.
Which fields are matched against the term varies by endpoint.
include[]optional arrayenumValues:sent_bySub-objects to expand in the response. When omitted, sub-objects are returned as null.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of email_logResources in this page.
idstringEmail log ID.
objectstringenumValues:email_logResource type identifier.
send_statusstringenumValues:sentpendingEmail send status.
pending: the email is queued and has not been sent yet.sent: the email has been handed off for delivery.
recipientsarray of stringRecipient email addresses.
subjectstringnullableEmail subject line.
filenamestringnullableFilename of the attached document.
sent_byactorExpandablenullableThe user who sent the email.
Absent for emails the platform sends automatically (for example system notifications), which are not attributed to a user.
idstringUnique identifier of the actor.
objectstringenumValues:actorResource type identifier.
typestringenumValues:userapi_keyagentActor type.
user: a human user account.api_key: a programmatic caller authenticating with an API key.agent: an automated agent acting on the account's behalf.group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.
namestringnullableThe actor's display name.
handlestringnullableHuman-readable handle identifying the actor.
- For
useractors: the user's email address. - For
api_keyactors: the redacted key value.
Other actor types carry no handle.
avatar_urlstringnullableURL of the actor's profile photo, if one is set.
Only populated for user actors.
Assigned 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