Get Message Summaries

This endpoint retrieves summaries of messages from specified folders, including details like the sender, subject, creation time, and file size. Specify the metadata=true query string parameter to additionally include the attachments, expirationDate, securityEnvelope, and tracking properties.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

The Id of the folder you are getting messages from. This can be retrieved from the Get Folder Information request.

int32

The number of results returned per page in the response.

int32

The page number for the results returned.

string

Sorts the results based on the provided value. This includes createTime.

int32
enum

The direction that the results will be sorted by. This can be either DESC or ASC.

Allowed:
boolean

If set to True, the response will only return unread messages.

boolean

If set to True, the response will return retracted messages.

boolean

If set to True, the response will return message metadata for all messages.

string

Text filter for sorting or searching for messages.

int32

Filters the resulting messages by account Id.

int32

The last message Id received in the folder.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json