Reminders

Get the reminder lead times and channel availability

The account-wide default lead time, any per-job overrides, and which channels (email/SMS) are available on the current plan. Requires the read scope.

get/api/v1/reminder-settings

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/reminder-settings
  • Auth: HTTP bearer

Response

Reminder configuration for the account.

extra_sentencestring nullable required

Optional extra sentence appended to the fixed reminder wording, or null.

reminder_capinteger required

How many reminders per shift this plan allows (1 / 2 / 3).

Example response

{
  "global_default": {
    "days_before": 1
  },
  "global_defaults": [
    {
      "days_before": 1
    }
  ],
  "job_overrides": [
    {
      "days_before": 1
    }
  ]
}

Changes

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