List Email Logs

Beta
GET/v1/core/email-logs

This endpoint is idempotent. Learn more

Returns a paginated list of email logs for the current account.

cursoroptional string

Query parameter: cursor for List Email Logs

limitoptional integer

Query parameter: limit for List Email Logs

qoptional string

Query parameter: q for List Email Logs

include[]optional arrayenumValues:sent_by

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Object type for EmailLog list

page_infoobject

Pagination metadata for EmailLog list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of EmailLog resources in this page

idstring

Email log ID.

objectstringenumValues:email_log

Resource type identifier.

has_sentboolean

Whether the email was sent.

recipientsarray of string

Recipient email addresses.

subjectstringnullable

Email subject line.

filenamestringnullable

Filename of any attachment.

ses_message_idstringnullable

SES message ID returned by AWS.

sent_byobjectExpandablenullable

Actor who sent the email. Null when the email was sent by the system, or when the caller did not request include=sent_by.

idstring

Actor ID.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

namestringnullable

Display name.

handlestringnullable

Human-readable handle (email for users, redacted value for API keys, slug for agents).

roleobjectnullable

Assigned role.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Email Logs