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

Cursor token used to retrieve the next or previous page of results.

limitoptional integer

Maximum number of results per page (default: 100, max: 1000).

qoptional string

Search query used to filter results.

include[]optional arrayenumValues:sent_by

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

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

previous_page_urlstringnullable

URL 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

Resources in this page.

idstring

Email log ID.

objectstringenumValues:email_log

Resource type identifier.

send_statusstringenumValues:sentpending

Email send status.

recipientsarray of string

Recipient email addresses.

subjectstringnullable

Email subject line.

filenamestringnullable

Filename of any attachment.

sent_byobjectExpandablenullable

Actor who sent the email. Null when the email was sent by the system.

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