List emails
GET/v2/activities/emails
Fetches multiple email records. The records can be filtered, paged, and sorted according to the respective parameters.
Request
Query Parameters
IDs of emails to fetch. If a record can't be found, that record won't be returned and your request will be successful
Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Filters emails by whether they have bounced or not
Filters emails by crm_activity_id. Multiple crm activty ids can be applied
Filters emails by action_id. Multiple action ids can be applied
Filters emails by user_id. Multiple User ids can be applied
Filters emails by status. Multiple status can be applied, possible values are sent, sent_from_gmail, sent_from_external, pending, pending_reply_check, scheduled, sending, delivering, failed, cancelled, pending_through_gmail, pending_through_external
Filters emails by cadence. Multiple cadence ids can be applied
Filters emails by step. Multiple step ids can be applied
Filters emails by one-off only
Specify explicit scoped fields desired on the Email Resource.
Filters emails by person_id. Multiple person ids can be applied
Filters emails by recipient email address. Multiple emails can be applied.
Filters emails by personalization score
Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Key to sort on, must be one of: updated_at, recipient, send_time, account, subject, views, clicks, replies. Defaults to updated_at
Direction to sort in, must be one of: ASC, DESC. Defaults to DESC
How many records to show per page in the range [1, 100]. Defaults to 25
The current page to fetch results from. Defaults to 1
Whether to include total_pages and total_count in the metadata. Defaults to false
Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data
Responses
- 200
Success
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
ID of Email
Datetime of when the email was created
Datetime of when the email was last updated
Email address of the recipient
Status of this email through the sending process. Possible values are: sent, sent_from_gmail, sent_from_external, pending, pending_reply_check, scheduled, sending, delivering, failed, cancelled, pending_through_gmail, pending_through_external
Whether this email bounced
When this email will be sent, or null if already sent
When this email was sent, or null if it was not sent
Whether this email had view tracking enabled
Whether this email had click tracking enabled
Selected headers that are included if this email used them. Available keys are: cc, bcc
Percentage of this email that has been personalized
Subject of the email. This field has been determined sensitive and requires a specific scope to access it.
Email Body
Error message of the email. This field has been determined sensitive and requires a specific scope to access it.
counts object
The number of times links in the email were clicked
The number of times the email was opened
The number of replies the email received
The number of unique devices that opened the email
The number of unique locations that opened the email
The number of attachments on the email
user object
User that sent this email
recipient object
The person whom received this email
mailing object
The mailing that this email was a part of
action object
Action that this email was sent from, or null if not sent through a cadence
task object
Task that this email was sent from, or null if not sent through a cadence
crm_activity object
CRM Activity associated with this email
cadence object
Cadence the email was sent on
step object
Step the email was sent on
email_template object
Template used for this email
additional_recipients object[]
The list of people, other than the (primary) recipient, who received this email via TO and CC
{
"id": 1,
"created_at": "2024-01-01T00:00:00.000000+00:00",
"updated_at": "2024-01-01T00:00:00.000000+00:00",
"recipient_email_address": "bob.smith@example.com",
"status": "sent",
"bounced": false,
"send_after": "2024-01-01T00:00:00.000000+00:00",
"sent_at": "2024-01-01T00:00:00.000000+00:00",
"view_tracking": true,
"click_tracking": true,
"headers": {
"cc": "sb@salesloft.com",
"bcc": "track@salesforce.com"
},
"personalization": "13.4",
"subject": "string",
"body": "Hello",
"error_message": "string",
"counts": {
"clicks": 2,
"views": 3,
"replies": 1,
"unique_devices": 4,
"unique_locations": 3,
"attachments": 0
},
"user": {
"id": 1,
"_href": "https://api.salesloft.com/v2/users/1"
},
"recipient": {
"id": 1,
"_href": "https://api.salesloft.com/v2/people/1"
},
"mailing": {
"id": 1
},
"action": {
"id": 1
},
"task": {
"id": 1
},
"crm_activity": {
"id": 1,
"_href": "https://api.salesloft.com/v2/crm_activities/1"
},
"cadence": {
"id": 1,
"_href": "https://api.salesloft.com/v2/cadences/1"
},
"step": {
"id": 1,
"_href": "https://api.salesloft.com/v2/steps/1"
},
"email_template": {
"id": 1,
"_href": "https://api.salesloft.com/v2/email_templates/1"
},
"additional_recipients": [
{
"id": 2,
"_href": "https://api.salesloft.com/v2/people/2"
}
]
}