Emails
Returns multiple email records. The records can be filtered, paged, and sorted according to the respective parameters.
View-Specific Information
The Subject and Body columns return NULL if the access token does not include the required privileged scopes.To access data from the Body column, the email_bodies privileged scope must be granted. To access data from the Subject column, the email_contents privileged scope is required.
These privileged scopes can be granted when creating the API key or when configuring a custom OAuth application.
Select
The driver uses the Salesloft API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver.
| Column | Supported Operators |
| Id | =, IN |
| ActionId | =, IN |
| Bounced | = |
| CadenceId | =, IN |
| CrmActivityId | =, IN |
| SentAt | >, >=, <, <= |
| Status | =, IN |
| UpdatedAt | >, >=, <, <= |
| UserId | =, IN |
| EmailTemplateId | =, IN |
SELECT * FROM Emails WHERE Id = '123'
SELECT * FROM Emails WHERE CadenceId IN ('123', '321')
SELECT * FROM Emails WHERE Status IN ('sent', 'scheduled')
SELECT * FROM Emails WHERE SentAt >= '2022-12-01'
SELECT * FROM Emails WHERE UpdatedAt >= '2022-12-01'
SELECT * FROM Emails WHERE UserId IN ('123', '321')
Note: When filtering on datetime columns (such as SentAt or UpdatedAt) using
time values, timestamps must include
microsecond precision (for example, '2022-12-01T18:00:28.907000'). Providing
only millisecond precision may return incorrect results.
Columns
| Name | Type | Description |
| Id [KEY] | Integer | The Id of the Email. |
| ActionId | Integer | The ActionId of the Email. |
| Bounced | Boolean | The Bounced of the Email. |
| CadenceId | Integer | The CadenceId of the Email. |
| ClickTracking | Boolean | The ClickTracking of the Email. |
| CountsAttachments | Integer | The CountsAttachments of the Email. |
| CountsClicks | Integer | The CountsClicks of the Email. |
| CountsReplies | Integer | The CountsReplies of the Email. |
| CountsUniqueDevices | Integer | The CountsUniqueDevices of the Email. |
| CountsUniqueLocations | Integer | The CountsUniqueLocations of the Email. |
| CountsViews | Integer | The CountsViews of the Email. |
| CreatedAt | Datetime | The CreatedAt of the Email. |
| CrmActivityId | Integer | The CrmActivityId of the Email. |
| HeadersBCC | String | The HeadersBCC of the Email. |
| HeadersCC | String | The HeadersCC of the Email. |
| MailingId | Integer | The MailingId of the Email. |
| Personalization | String | The Personalization of the Email. |
| RecipientId | Integer | The RecipientId of the Email. |
| RecipientEmailAddress | String | The RecipientEmailAddress of the Email. |
| SendAfter | Datetime | The SendAfter of the Email. |
| SentAt | Datetime | The SentAt of the Email. |
| Status | String | The Status of the Email.
The allowed values are sent, sent_from_gmail, sent_from_external, pending, pending_reply_check, scheduled, sending, delivering, failed, cancelled, pending_through_gmail, pending_through_external. |
| StepId | Integer | The StepId of the Email. |
| UpdatedAt | Datetime | The UpdatedAt of the Email. |
| UserId | Integer | The UserId of the Email. |
| ViewTracking | Boolean | The ViewTracking of the Email. |
| Subject | String | Subject of the email. |
| Body | String | Email Body. |
| ErrorMessage | String | Error message of the email. |
| DraftWithAI | Boolean | Whether this email body was drafted with AI assistance. |
| TaskId | Integer | Task Id that this email was sent from, or null if not sent through a cadence. |
| EmailTemplateId | Integer | Template Id used for this email. |
| AdditionalRecipientsIds | String | The comma-separated list of people ids, other than the (primary) recipient, who received this email via TO and CC. |
| MessageId | String | The unique message identifier of the email as defined by RFC 2822. |