Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB
Emails

List Emails

List all emails

get/emails

Query parameters

statusEmailStatus[]

If provided, only return emails with the given status.

If provided, only return emails with the given status.

-statusEmailStatus[]

If provided, only return emails without the given status.

If provided, only return emails without the given status.

[
  "draft"
]
idsstring[]

If provided, only return emails with the given IDs.

If provided, only return emails with the given IDs.

ordering'creation_date' | '-creation_date' | 'status' | '-status' | 'publish_date' | '-publish_date' | 'subject' | '-subject' | 'email_type' | '-email_type' | 'modification_date' | '-modification_date' | 'clicks' | '-clicks' | 'opens' | '-opens' | 'click_rate' | '-click_rate' | 'open_rate' | '-open_rate' | 'page_views_lifetime' | '-page_views_lifetime' | 'page_views_30' | '-page_views_30' | 'page_views_7' | '-page_views_7' | 'webmentions' | '-webmentions' | 'subscriptions' | '-subscriptions' | 'paid_subscriptions' | '-paid_subscriptions' | 'unsubscriptions' | '-unsubscriptions' | 'replies' | '-replies' | 'comments' | '-comments' | 'social_mentions' | '-social_mentions' | 'permanent_failure_rate' | '-permanent_failure_rate' | 'complaint_rate' | '-complaint_rate'

The ordering to apply to the results.

Example:-publish_date

The ordering to apply to the results.

creation_date__startstring date

If provided, only return emails created after the given date.

If provided, only return emails created after the given date.

creation_date__endstring date

If provided, only return emails created before the given date.

If provided, only return emails created before the given date.

publish_date__startstring date

If provided, only return emails published after the given date.

If provided, only return emails published after the given date.

publish_date__endstring date

If provided, only return emails published before the given date.

If provided, only return emails published before the given date.

excluded_fieldsEmailExcludableField[]

If provided, exclude the given field(s) from the response. This can improve performance for large responses.

If provided, exclude the given field(s) from the response. This can improve performance for large responses.

[
  "body"
]
sourceEmailSource[]

If provided, only return emails from the given source(s).

If provided, only return emails from the given source(s).

[
  "api"
]
archival_modeArchivalMode[]

If provided, only return emails with the given archival mode.

If provided, only return emails with the given archival mode.

email_typeEmailType[]

The type of emails to return. Defaults to all types.

The type of emails to return. Defaults to all types.

subjectstring

If provided, only return emails with a subject that contains the given string.

If provided, only return emails with a subject that contains the given string.

attachmentsstring[]

If provided, only return emails with the given attachments.

If provided, only return emails with the given attachments.

snippet_idstring[]

If provided, only return emails that reference the given snippets.

If provided, only return emails that reference the given snippets.

deliveries__startinteger

If provided, only return emails with at least this many deliveries.

Example:100

If provided, only return emails with at least this many deliveries.

deliveries__endinteger

If provided, only return emails with at most this many deliveries.

Example:1000

If provided, only return emails with at most this many deliveries.

click_rate__startnumber

If provided, only return emails with a click rate greater than or equal to the given value.

Example:0.1

If provided, only return emails with a click rate greater than or equal to the given value.

click_rate__endnumber

If provided, only return emails with a click rate less than or equal to the given value.

Example:0.5

If provided, only return emails with a click rate less than or equal to the given value.

open_rate__startnumber

If provided, only return emails with an open rate greater than or equal to the given value.

Example:0.2

If provided, only return emails with an open rate greater than or equal to the given value.

open_rate__endnumber

If provided, only return emails with an open rate less than or equal to the given value.

Example:0.8

If provided, only return emails with an open rate less than or equal to the given value.

pageinteger

The page number of the paginated response.

Example:1

The page number of the paginated response.

Response

OK

nextstring nullable

The URL to the next page of results, if any.

previousstring nullable

The URL to the previous page of results, if any.

countinteger required

The total number of results across all pages.