Email Logs
The
email_log objectA record of an email sent on the account's behalf, such as an invoice or a user invitation.
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_byactornullableThe 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.