API Docs / Operations / Tasks - Recurring / List Recurring Task Schedules

List Recurring Task Schedules

GET /tenants/{tenant}/recurring-tasks/{taskCode}/schedules

Returns a paged list of a recurring task's schedules, the default schedule pinned first, each with its client count and first few clients. Search matches the schedule name or a linked client's name or code, and keeps every schedule containing a match.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

taskCode* path string
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.

ClientCount Name

Field to sort by.

ClientCount Name

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

search query string

Search term to filter results

Search term to filter results

Responses

401 Unauthorized – Invalid or missing API key
404 Not Found