Schedules

List upcoming shifts for a schedule

Occurrences in [from, to] plus the schedule's roster and each date's attendance/exception status. Requires the read scope.

get/api/v1/schedules/{id}/occurrences

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/schedules/{id}/occurrences
  • Auth: HTTP bearer

Path parameters

idstring required

The schedule's numeric id.

Example:42

Query parameters

fromstring

Start of the range: "yyyy-MM-dd" (interpreted in the account timezone) or a full ISO 8601 datetime. Defaults to now.

Example:2026-07-01
tostring

End of the range, same formats as from. Defaults to 90 days from now.

Example:2026-09-30
limitinteger

Maximum rows to return (default 20, max 100).

Example:20

Response

Upcoming occurrences.

schedule_idnumber required

The schedule these occurrences belong to.

time_zonestring required

IANA timezone used to render dates.

Example response

{
  "time_zone": "America/Chicago",
  "occurrences": [
    {
      "label": "Tue Jul 14 9:00 AM"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.