Skip to main content

List schedules

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 any type, by its id from listReports or createReport. 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. updateReportSchedules replaces every schedule, so the ids change each time you call it.
  • frequency (string, required): How often the schedule runs. hourly runs every day at each time in selectedTimes. daily, weekly, monthly and quarterly run whenever cronExpression fires; those made in the app run every day, on chosen weekdays, on chosen days of the month, or every three months, respectively. yearly can't be set through the API or the app, and also runs on cronExpression. One of daily, 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's timezone. For an hourly schedule, Rollstack generates it from selectedTimes and runs the report at those times instead. Monthly schedules made in the app can use L and #, such as 0 9 L * * (last day of the month) or 0 9 ? * 1#1 (first Monday).
  • selectedTimes (array of string, required): The times of day an hourly schedule runs, every day, as 24-hour HH:mm in the schedule's timezone. 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's timezone, written as if it were UTC: 2026-11-02T09:00:00Z means 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. null if the schedule never ends. Like startDate, this is a local date and time in the schedule's timezone, written as if it were UTC.
  • timezone (string, required): The timezone the schedule runs in. Its run times (cronExpression or selectedTimes), startDate and endDate are 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 as America/New_York.
  • syncIds (array of string or null, required): The syncs, from listReportSyncs, that the schedule updates on a report other than a SlideDeck. null when 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. null if it has no runs left before its endDate. Unlike startDate and endDate, this is an actual UTC time.