---
title: "Get the reminder lead times and channel availability"
method: GET
path: "/api/v1/reminder-settings"
tags: ["Reminders"]
---

# Get the reminder lead times and channel availability

`GET /api/v1/reminder-settings`

## Request

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

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.

## Response `200`

Reminder configuration for the account.

- ReminderSettingsResponse
  - `global_default` ReminderGlobalDefault, nullable, required: The first account-wide default lead time, or null if never configured. Prefer `global_defaults` when reading more than one reminder per shift.
    - `id` number, required: reminder_schedule_item id.
    - `days_before` integer, required: Whole days before the shift to send this reminder.
    - `hours_before` integer, required: Additional whole hours before the shift.
    - `minutes_before` integer, required: Additional whole minutes before the shift.
  - `global_defaults` ReminderGlobalDefault[], required: Every account-wide default lead time (longest first).
    - `id` number, required: reminder_schedule_item id.
    - `days_before` integer, required: Whole days before the shift to send this reminder.
    - `hours_before` integer, required: Additional whole hours before the shift.
    - `minutes_before` integer, required: Additional whole minutes before the shift.
  - `extra_sentence` string, nullable, required: Optional extra sentence appended to the fixed reminder wording, or null.
  - `reminder_cap` integer, required: How many reminders per shift this plan allows (1 / 2 / 3).
  - `job_overrides` ReminderJobOverride[], required: Per-job lead-time overrides. A job may have more than one row — one per lead. A live override set replaces the account defaults for that job.
    - `id` number, required: reminder_schedule_item id.
    - `job_id` number, required
    - `job_name` string, nullable, required
    - `days_before` integer, required: Whole days before the shift to send this reminder.
    - `hours_before` integer, required: Additional whole hours before the shift.
    - `minutes_before` integer, required: Additional whole minutes before the shift.
  - `channels` ReminderChannels, required
    - `email` object, required
      - `available` boolean, required: Email reminders are always available.
    - `sms` object, required
      - `available` boolean, required: Whether this account can actually send SMS/text reminders right now. This is the FULL gate the send loop applies (domain/smsGate via domain/reminderSelection): the plan must include SMS AND, for accounts created from 2026-08-10 on, a coordinator must have a verified mobile. See `reason` for which one is missing.
      - `reason` string, nullable, required: Why SMS is unavailable, or null when it is available.

## Other responses

- `401`: Missing or invalid API key.
- `403`: The API key lacks a scope required by this endpoint.

---

[API](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api.md) · [All operations](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api/llms.txt) · [OpenAPI document](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api/revisions/f8e7e26ba96f?raw)