latestOpenAPI 3.0.32026-08-208185259.4 KB

f00047222b8f

Emails

Get emails

Get emails matching the specified criteria.

get/api/v1/emails

Query parameters

filter[email.sent]string

The date range in which to search for e-mails that were sent. Value must be two ISO 8601-formatted dates separated by a colon (e.g. 2021-01-01T00:00:00Z:2021-01-31T00:00:00Z). An asterisk may be used as a placeholder to represent no minimum (e.g. *:2021-01-31T00:00:00Z). An asterisk may be used as a placeholder to represent no maximum (e.g. 2021-01-01T00:00:00Z:*).

filter[name]string

A string used to perform an exact case-insensitive partial match against the e-mails' subjects

filter[thread]string

The identifier of the e-mails belonging to the same e-mail thread

filter[ids]string

Select specific e-mails using e-mail identifiers. Value must be a comma-delimited list.

filter[owner.name]string

The case-insensitive name of the sender of an e-mail; examples: "Julius Caesar", "julius", and "CAESAR"

filter[owner.email]string

The case-insensitive e-mail address of the sender of an e-mail; examples: "julius.caesar@rome.gov", "JULIUS.CAESAR", and "@rome.gov"

filter[participants.name]string

The case-insensitive names of the participants of an e-mail; adding more participants will broaden the search. Value must be a comma-delimited list.

filter[participants.email]string

The case-insensitive e-mail addresses of the participants of an e-mail; adding more participants will broaden the search. Value must be a comma-delimited list.

page[size]integer

The maximum number of e-mails to return per page; if the number of matching e-mails is greater than the page size, the number of results returned is not guaranteed to be equal to the page size. The minimum value that may be specified is 1. The maximum value that may be specified is 100.

page[after]string

Response

Success