List Email History
Returns a paginated list of emails sent for the tenant. Supports filtering by status, date range, search, and metadata fields. Metadata filters use the format metadataParam=key=value (e.g., metadataParam=entityType=Proposal).
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) |
||
| status | query string | Filter by email status (Queued, Sending, Sent, Delivered, Failed, Bounced) |
Filter by email status (Queued, Sending, Sent, Delivered, Failed, Bounced) |
||
| fromDate | query string | Filter by emails created on or after this date (ISO 8601 format) |
Filter by emails created on or after this date (ISO 8601 format) |
||
| toDate | query string | Filter by emails created on or before this date (ISO 8601 format) |
Filter by emails created on or before this date (ISO 8601 format) |
||
| search | query string | Search in email subject and recipient email address |
Search in email subject and recipient email address |
||
| metadataParam | query array | Filter by custom metadata stored with the email. Each value should be in key=value format. Can specify multiple (e.g., metadataParam=entityType=Proposal&metadataParam=entityId=123) |
Filter by custom metadata stored with the email. Each value should be in key=value format. Can specify multiple (e.g., metadataParam=entityType=Proposal&metadataParam=entityId=123) |
||