List Scheduled Sends
Returns a paged list of scheduled sends, scoped to the send types the caller has permission to manage. Defaults to pending rows (Scheduled and Failed) when no status filter is given. Use limit=0 for a count-only query (the Scheduled tab badge).
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 array | Filter by one or more statuses. Defaults to Scheduled and Failed when omitted. |
Filter by one or more statuses. Defaults to Scheduled and Failed when omitted. |
||
| sendType | query array | Filter by one or more kinds of send |
Filter by one or more kinds of send |
||
| clientCode | query string | Filter by the related client's code |
Filter by the related client's code |
||
| createdByUserCode | query string | Filter by the user who scheduled the send |
Filter by the user who scheduled the send |
||
| search | query string | Search across subject and client name |
Search across subject and client name |
||