Retrieve email messages

Retrieves a list of email messages.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

q
string

Use this field to perform a partial search of text fields.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

Responses
200

List of email messages retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
from
required
string <email> <= 254 characters

Email address of the sender.

to
required
Array of strings <email> non-empty

List of email addresses to which the email message is sent.

subject
required
string <= 998 characters

Subject of the email message.

text
required
string

Body of the email message in plain text.

html
required
string

Body of the email message in HTML format.

id
string <= 50 characters

ID of the email message.

status
string
Default: "draft"

Status of the email message.

Enum: "draft" "outbox" "sending" "sent" "failed"
object

Metadata associated with the email message.

property name*
additional property
string
credentialHash
string

SMTP or Email Service Provider (ESP) credential ID.

cc
Array of strings <email>

List of CC email addresses to which the email message is sent.

bcc
Array of strings <email>

List of BCC email addresses to which the email message is sent.

Array of objects

Attachments of the email message.

Array
resourceType
required
string

Type of attachment resource.

resourceId
required
string <= 50 characters

ID of the attachment resource.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (Self) non-empty

Related links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/email-messages
Request samples
Response samples
application/json
[
  • {
    }
]