List all Emails

get

https://api.unipile.com/v2/{account_id}/emails

Returns a list of emails in the account mailbox. Emails are returned sorted by their date, with the most recent appearing first. Search mode applies when q, from, to, or any_email is set. Filter mode applies for browse-only queries (dates, folder scope, read/starred/attachment status).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

^acc_(.*)$

ID of the Account (acc_xxx) to call the method on behalf of.

Query Params

string

Full-text search in the email subject and body (case-insensitive, partial match). Activates search mode: results may be approximate and non-exhaustive (provider-dependent, ~1000 results on Outlook). Combine with from, to, or any_email to narrow by participant address.

meta_only

boolean

Defaults to false

Speed up the response by only returning the email metadata. body and body_plain are empty strings, and attachments metadata is excluded.

string

Return messages sent to the given email address. For Outlook, some messages matching this filter may be missing due to a provider limitation. Use GET /threads/:thread_id to retrieve a specific conversation. Activates search mode: results may be approximate and non-exhaustive (provider-dependent, ~1000 results on Outlook).

from

string

Return messages sent from the given email address. For Outlook, some messages matching this filter may be missing due to a provider limitation. Use GET /threads/:thread_id to retrieve a specific conversation. Activates search mode: results may be approximate and non-exhaustive (provider-dependent, ~1000 results on Outlook).

any_email

string

Return messages where at least one of the given comma-separated email addresses appears as a participant (from, to, cc, or bcc). For Outlook, some messages matching this filter may be missing due to a provider limitation. Use GET /threads/:thread_id to retrieve a specific conversation. Activates search mode: results may be approximate and non-exhaustive (provider-dependent, ~1000 results on Outlook).

has_attachment

boolean

Filter to only return emails with or without attachments. For Outlook with meta_only=true, this uses the provider attachment flag, which excludes inline attachments.

is_starred

boolean

Filter to only return starred or unstarred emails.

is_unread

boolean

Filter to only return unread or read emails.

before

date-time

Filter to only return emails sent before the given datetime (exclusive). Must use a supported date-time format. See supported date formats.

exclude_folder

string

Filter to only return emails that are not in any of the folders specified in the comma-separated list of folder IDs.

after

date-time

Filter to only return emails sent after the given datetime (exclusive). Must use a supported date-time format. See supported date formats.

offset

number

An offset used for pagination, if supported by the provider, else use cursor.

cursor

string

A cursor used for pagination. If supported by the provider, use next_cursor given by the previous page of the list, else use offset.

limit

number

≥ 1

Defaults to 20

The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response