Sign in

v1

latestOpenAPI 3.0.02026-07-249301.3 MB
Emails

List all emails

Returns a list of emails.

get/api/v1/emails

Query parameters

message_idstring

A filter to target items by message_id.

thread_idstring

A filter to target items by thread identifier.

meta_onlyboolean

Speed up the response by only returning the email metadata, excluding the body and attachments metadata.

include_headersboolean

Include the email headers in the response. meta_only must be false.

cursorstring

A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.

beforestring

A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).

Example:2025-12-31T23:59:59.999Z
afterstring

A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).

Example:2025-12-31T23:59:59.999Z
limitinteger

A limit for the number of items returned in the response. The value can be set between 1 and 250.

Example:100
searchstring

Free-text search applied to subject and body at the same time. Microsoft: requests combining search with from, to, any_email, before, after, thread_id, message_id or exclude_folders are rejected with invalid_request. IMAP: can be slow, only available within one folder, specified with folder or role, before and after are evaluated at day granularity, support depends on the IMAP server. IMAP requests combining search with any_email, exclude_folders, thread_id, multiple from values or multiple to values are rejected with invalid_request.

any_emailstring

A filter to target items sent to or received from a comma-separated list of email addresses.

tostring

A filter to target items related to a certain recipient, either in the to, cc or bcc field.

fromstring

A filter to target items related to a certain sender.

exclude_foldersstring

A filter to exclude items from a comma-separated list of folder provider_id ( ignored if folder parameter is used ).

folderstring

A filter to target items related to a certain folder provider_id.

account_idstring required

A filter to target items related to a certain account.

Response

OK

object'EmailList' required

Example response

{
  "items": [
    {
      "date": "2025-12-31T23:59:59.999Z",
      "read_date": "2025-12-31T23:59:59.999Z"
    }
  ]
}