List Recurring Task Occurrences
Returns, in date order, one page of this recurring task's occurrences for one client whose occurrence date falls in the window: occurrences still to be created (with the projected task that will open the upcoming task preview), tasks already created from it (with their current status), and occurrences that were deleted - either a created task that was deleted, or an upcoming occurrence cancelled before creation - with who deleted it and when. Omit clientCode for a task that runs without a client. Pass a preset dateRange, or CustomDateRange with startDate and endDate (at most five years). Pass status to show only Projected (upcoming), Created or Deleted occurrences. Standard offset/limit paging. A deleted occurrence has no task, so it carries the projected code alone - that is what the restore endpoint takes. An occurrence that was deleted and later restored is live again and reports who deleted it and who brought it back.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| code* | path string | |
| startDate | query string (date) | |
| endDate | query string (date) | |
| status | query enum | Projected Created Deleted |
Projected Created Deleted |
||
| clientCode | query string | |
| dateRange | query enum | ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange |
ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange |
||
| 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) |
||