List Engagements
Lists all Engagements for the given tenant.
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 engagement status (Unsent, Sent, Accepted, Rejected) |
Filter by engagement status (Unsent, Sent, Accepted, Rejected) |
||
| search | query string | Search across engagement code, client name, and client code (minimum 3 characters) |
Search across engagement code, client name, and client code (minimum 3 characters) |
||
| dateRange | query string | Preset date range. If CustomDateRange, dateFrom and dateTo are required. |
Preset date range. If CustomDateRange, dateFrom and dateTo are required. |
||
| dateFrom | query string | Filter engagements from this date. Only valid when dateRange=CustomDateRange |
Filter engagements from this date. Only valid when dateRange=CustomDateRange |
||
| dateTo | query string | Filter engagements up to this date. Only valid when dateRange=CustomDateRange |
Filter engagements up to this date. Only valid when dateRange=CustomDateRange |
||