GET v2/activities/emails.json

action_id (array, query, optional)

Filters emails by action_id. Multiple action ids can be applied

bounced (boolean, query, optional)

Filters emails by whether they have bounced or not

cadence_id (array, query, optional)

Filters emails by cadence. Multiple cadence ids can be applied

crm_activity_id (array, query, optional)

Filters emails by crm_activity_id. Multiple crm activty ids can be applied

email_addresses (array, query, optional)

Filters emails by recipient email address. Multiple emails can be applied.

ids (array, query, optional)

IDs of emails to fetch. If a record can't be found, that record won't be returned and your request will be successful

include_paging_counts (boolean, query, optional)

Whether to include total_pages and total_count in the metadata. Defaults to false

limit_paging_counts (boolean, query, optional)

Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

one_off (boolean, query, optional)

Filters emails by one-off only

page (integer, query, optional)

The current page to fetch results from. Defaults to 1

per_page (integer, query, optional)

How many records to show per page in the range [1, 100]. Defaults to 25

person_id (array, query, optional)

Filters emails by person_id. Multiple person ids can be applied

personalization (array, query, optional)

Filters emails by personalization score

scoped_fields (array, query, optional)

Specify explicit scoped fields desired on the Email Resource.

sent_at (array, query, optional)

Equality filters that are applied to the sent_at field. A single filter can be used by itself or combined with other filters to create a range. ---CUSTOM--- {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}

sort_by (string, query, optional)

Key to sort on, must be one of: updated_at, send_time. Defaults to updated_at

sort_direction (string, query, optional)

Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

status (array, query, optional)

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

step_id (array, query, optional)

Filters emails by step. Multiple step ids can be applied

updated_at (array, query, optional)

Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range. ---CUSTOM--- {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}

user_id (array, query, optional)

Filters emails by user_id. Multiple User ids can be applied