List schedules

get

https://platform-reporting.vertexcloud.com/api/v1/schedules

Retrieve a list of schedules for running report definitions, optionally filtered by template, category, status, name, frequency, and effective date range.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

templateId

array of uuids

Filter by template UUID(s) (via the underlying report definition). Multiple values are combined as a union.

templateId

categoryId

array of uuids

Filter by report category UUID(s) (via the underlying report definition). Multiple values are combined as a union.

categoryId

enabled

boolean

Filter by enabled status

scheduleType

string

enum

Filter by schedule type

Allowed:

frequency

array of objects

Filter by recurrence frequency (multiple values combined as a union; only recurring schedules are returned when set).

frequency

Allowed:

name

string

Filter by schedule name (case-insensitive substring match)

startDateFrom

date

Effective from this date onwards (ISO-8601 format, inclusive)

startDateTo

date

Effective up to this date (ISO-8601 format, inclusive)

offset

integer

≥ 0

Defaults to 0

Number of items to skip (for pagination)

limit

int32

1 to 100

Defaults to 25

Maximum number of items to return

sortBy

string

enum

Defaults to CREATED_AT

Field to sort by

Allowed:

sortOrder

string

enum

Defaults to ASC

Sort direction

Allowed:

Responses

200List of schedules

400Invalid query parameters

401Unauthorized

403Forbidden

500Internal server error