Retrieves the unique messageIds of messages using the specified criteria.

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.

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

The folder id of the desired folder.

int32

The number of rows to return per page.

int32

The page to return messages for.

boolean

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

string

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

int32

Used to specify the last message id received to receive summaries only for messages created since the ID reference.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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