Email Logs

The email_log object

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

idstring

Email log ID.

objectstringenumValues:email_log

Resource type identifier.

send_statusstringenumValues:sentpending

Email send status.

  • pending: the email is queued and has not been sent yet.
  • sent: the email has been handed off for delivery.
recipientsarray of string

Recipient email addresses.

subjectstringnullable

Email subject line.

filenamestringnullable

Filename of the attached document.

sent_byactornullable

The user who sent the email.

Absent for emails the platform sends automatically (for example system notifications), which are not attributed to a user.

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

Assigned role.

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

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by