Retrieves the message summary information of all messages using the specified criteria.

get

https://sandbox.datamotion.com/SMCApi/v3/content/messages

Specify the metadata=true query string parameter to additionally include the attachments, expirationDate, securityEnvelope, and tracking properties.

HTTP Status Code 400 Error Codes (error property):

InvalidPageNumber - An invalid page number was provided. Valid page numbers are > 0.

InvalidPageSize - An invalid page size was provided. Valid page sizes are > 0.

InvalidFolderId - An invalid folder id was provided. Valid folder ids are > 0. Note: If the UnreadOnly=true query string parameter is provided, only inbox folder types can be provided.

HTTP Status Code 401 Error Codes (error property):

Unauthorized - An Authorization token was not provided and is required.

AccessTokenInvalid - The access token is expired or invalid.

Query Params

folderId

int32

The folder id of the desired folder.

pageSize

int32

The number of rows to return per page.

pageNumber

int32

The page to return messages for.

sortBy

string

A field to sort the results by. The default is messageId.

sortDirection

string

enum

The direction to sort the results by. The default is ASC.

Allowed:

unreadOnly

boolean

true to include unread messages only (excludes all read messages); otherwise false. The default is false.

retractedMsgs

boolean

true to include retracted messages in the results; otherwise false. The default is false.

metadata

boolean

true to additionally include the attachments, expirationDate, securityEnvelope, and tracking properties; otherwise false; The default is false.

filter

string

A filter value to filter the results. This value is applied to the subject and senderAddress values.

lastMessageIdReceived

int32

Used to set floor of message list, only newer messages than this value will be returned

Headers

Authorization

string

required

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Response

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

application/json

text/json

200OK

400BadRequest

401Unauthorized

403Forbidden

500InternalServerError