Schedules

List schedules

All active (non-archived) schedules for the account. Requires the read scope.

get/api/v1/schedules

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/schedules
  • Auth: HTTP bearer

Response

The account's schedules.

idnumber required

Schedule id.

descriptionstring required

Schedule label.

job_idnumber required

Job/role id (use for per-job reminder overrides).

job_namestring nullable required

Associated job/role name.

group_namestring nullable required

Associated group name, or null.

notesstring nullable required

Free-text internal notes.

next_occurrence_atnumber nullable required

Epoch ms (UTC) of the next upcoming, attendable occurrence, or null.

last_reminder_sentnumber nullable required

Epoch ms (UTC) reminders were last sent for this schedule, or null.

roster_countnumber required

Number of volunteers assigned to this schedule.

Example response

[
  {
    "id": 42
  }
]

Changes

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