List Messages
Returns a paginated flat list of individual messages (not grouped by thread). When configCode query param is omitted, searches across mailbox configurations the current user can access (owned or shared). When configCode is provided, scopes to that single configuration. Supports filtering by direction, participant email/domain, include/exclude message IDs, and search. Pagination defaults: offset=0, limit=10, max limit=50.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| offset | query integer (int32) | Number of records to skip (default: 0). Use with limit for pagination. |
Number of records to skip (default: 0). Use with limit for pagination. |
||
| limit | query integer (int32) | Maximum number of records to return (default: 10, max: 50) |
Maximum number of records to return (default: 10, max: 50) |
||
| sortBy | query enum | Field to sort by. |
Field to sort by. |
||
| sortDesc | query boolean | Sort in descending order (true) or ascending order (false, default) |
Sort in descending order (true) or ascending order (false, default) |
||
| configCode | query array | Filter by configuration code (GUID, repeatable). Omit to search across all read-enabled configs. |
Filter by configuration code (GUID, repeatable). Omit to search across all read-enabled configs. |
||
| direction | query string | Filter by email direction (Inbound = received emails, Outbound = sent emails) |
Filter by email direction (Inbound = received emails, Outbound = sent emails) |
||
| search | query string | Search by subject or sender email/name |
Search by subject or sender email/name |
||
| participantEmail | query array | Filter by participant email address - matches From, To, and Cc fields. Can specify multiple (OR logic). |
Filter by participant email address - matches From, To, and Cc fields. Can specify multiple (OR logic). |
||
| participantDomain | query array | Filter by participant email domain - matches From, To, and Cc fields. Can specify multiple (OR logic). |
Filter by participant email domain - matches From, To, and Cc fields. Can specify multiple (OR logic). |
||
| includeMessageId | query array | Force-include specific message UniqueIds regardless of participant filters (repeatable). |
Force-include specific message UniqueIds regardless of participant filters (repeatable). |
||
| excludeMessageId | query array | Force-exclude specific message UniqueIds even if they match participant filters (repeatable). |
Force-exclude specific message UniqueIds even if they match participant filters (repeatable). |
||