Email Logs

The email_log object

A record of an email the platform sent on the account's behalf, such as an order acknowledgement or a user invitation.

An email that never reached the delivery provider is recorded here too, rather than disappearing.

idstring

Email log ID.

objectstringenumValues:email_log

Resource type identifier.

send_statusstringenumValues:sentpending

Whether the email was handed off to the delivery provider.

  • sent: the provider accepted the email for delivery. It does not confirm that the recipient's mail server accepted it.
  • pending: the email was never handed off — the send attempt failed, or it was suppressed because the account is in sandbox mode.
recipientsarray of string

Recipient email addresses.

subjectstringnullable

Email subject line.

filenamestringnullable

Filename of the document attached to the email.

sent_byactornullable

The user or API key that sent the email.

Emails the platform sends automatically, such as system notifications, are not attributed to an actor.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor 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.
namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

  • For user actors: the user's email address.
  • For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

The role the actor holds in the account, which determines what it is permitted to do.

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

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

GETList Email LogsEmail LogsGETRetrieve Email LogEmail Logs