v6

latestOpenAPI 3.1.02026-08-047720752.5 KB

Emails

List emails

Lists email metadata from your workspace's connected mailboxes. Email content is never returned. At least one of linked_object with linked_record_ids, participants, or domain must be supplied — there is no way to list every email. When several are supplied they are combined with OR: emails matching any of the filters are returned. Filters that identify your own workspace — a member's or invited member's address, one of your mailboxes, or any of their domains — are ignored. Emails from a mailbox shared with your workspace as metadata only are returned without a subject line. An email that reached more than one of your mailboxes is returned once, and linked_records is derived when you make the request rather than stored, so it reflects your records as they are now.

This endpoint is in alpha and may be subject to breaking changes as we gather feedback.

Required scopes: email:read, record_permission:read, object_configuration:read.

get/v2/emails

Query parameters

limitinteger

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

Example:25

cursorstring

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_objectstring

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.

linked_record_idsstring

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.

participantsstring

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

domainstring

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

Example:fundstack.com

sent_afterstring nullable

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

sent_beforestring nullable

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

Response

Success

Example response

{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "mailbox_id": "7f3a1c88-2e4b-4d59-9a0c-6b8d5e7f1a23",
        "email_id": "d2c4f0a1-5b6e-4a7c-8d9e-1f2a3b4c5d6e"
      },
      "sent_at": "2023-01-01T15:00:00.000000000Z",
      "direction": "outbound",
      "subject_line": "Re: Q3 renewal",
      "participants": [
        {
          "role": "from",
          "email_address": "person@company.com",
          "email_domain": "fundstack.com",
          "name": "Simon Mitchell"
        }
      ],
      "linked_records": [
        {
          "object_slug": "people",
          "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
          "record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
        }
      ]
    }
  ]
}