Skip to main content
GET
List emails

Authorizations

Authorization
string
header
required

This API uses OAuth 2.0 with the authorization code grant flow.

Query Parameters

limit
integer
default:25

The maximum number of emails to return. Must be between 1 and 50. Defaults to 25.

Required range: 1 <= x <= 50
Example:

25

cursor
string

A pagination cursor used to fetch the next page of emails. Responses with more emails will include a cursor for you to use here. If not provided, the first page will be returned.

linked_object
string

The object to filter emails by. Must be the slug or ID of either the people or companies object. If provided, linked_record_ids must also be provided.

Minimum string length: 1
linked_record_ids
string

A comma-separated list of up to 10 record IDs to filter emails by. All IDs must belong to the object given in linked_object, so filtering by both people and companies requires two requests. If provided, linked_object must also be provided.

participants
string
default:""

A comma-separated list of up to 10 email addresses. Emails that include at least one of them as a participant are returned.

domain
string

A domain to filter emails by. Emails with at least one participant at this domain are returned.

Minimum string length: 1
Example:

"fundstack.com"

sent_after
string | null

Only return emails sent after this timestamp. sent_after is exclusive, so an email sent at exactly this timestamp is not returned.

sent_before
string | null

Only return emails sent before this timestamp. sent_before is exclusive, so an email sent at exactly this timestamp is not returned.

Response

200 - application/json

Success

Success

data
object[]
required
pagination
object
required