List schedules
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/reports/{id}/schedules
The schedules of a report of any type, with the syncs each updates and when each runs next, or null for one that never runs again. Read them before updateReportSchedules, which replaces them all.
Requires the slide_decks:read scope.
Operation ID: getReportSchedules.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.
Response 200
Success
application/json: array of object
id(string, required): Unique identifier for the schedule.updateReportSchedulesreplaces every schedule, so the ids change each time you call it.frequency(string, required): How often the schedule runs.hourlyruns every day at each time inselectedTimes.daily,weekly,monthlyandquarterlyrun whenevercronExpressionfires; those made in the app run every day, on chosen weekdays, on chosen days of the month, or every three months, respectively.yearlycan't be set through the API or the app, and also runs oncronExpression. One ofdaily,weekly,monthly,quarterly,hourly,yearly.cronExpression(string, required): When the schedule runs, as a five-field cron expression (minute, hour, day of month, month, day of week) in the schedule'stimezone. For anhourlyschedule, Rollstack generates it fromselectedTimesand runs the report at those times instead. Monthly schedules made in the app can useLand#, such as0 9 L * *(last day of the month) or0 9 ? * 1#1(first Monday).selectedTimes(array of string, required): The times of day anhourlyschedule runs, every day, as 24-hourHH:mmin the schedule'stimezone. Other frequencies don't use it; it's empty on those set through the API.startDate(string (date-time), required): When the schedule starts: it never runs the report before this date and time. This is a local date and time in the schedule'stimezone, written as if it were UTC:2026-11-02T09:00:00Zmeans 9:00 on November 2, 2026 in that timezone, not 9:00 UTC.endDate(string (date-time) or null, required): When the schedule ends: it never runs the report after this date and time.nullif the schedule never ends. LikestartDate, this is a local date and time in the schedule'stimezone, written as if it were UTC.timezone(string, required): The timezone the schedule runs in. Its run times (cronExpressionorselectedTimes),startDateandendDateare all local times in this timezone, so a schedule set for 9:00 keeps running at 9:00 local time when daylight saving time starts or ends. Given as an IANA timezone name, such asAmerica/New_York.syncIds(array of string or null, required): The syncs, fromlistReportSyncs, that the schedule updates on a report other than aSlideDeck.nullwhen it updates the whole report, which a slide deck always does.nextRunAt(string (date-time) or null, required): When the schedule will next run the report.nullif it has no runs left before itsendDate. UnlikestartDateandendDate, this is an actual UTC time.