---
title: "Get the current account"
method: GET
path: "/api/v1/account"
tags: ["Account"]
---

# Get the current account

`GET /api/v1/account`

## Request

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

Plan, entitlements, current reminder mode, and usage vs limits for the account the API key belongs to. Requires the `read` scope.

## Response `200`

The account overview.

- AccountResponse
  - `account` object, required
    - `id` number, required
    - `name` string, nullable, required
    - `time_zone` string, nullable, required: IANA timezone id, or null if unset.
    - `unique_code` string, nullable, required: Public open-dates embed code for this account, or null.
    - `created_at` number, required: Epoch milliseconds (UTC).
  - `plan` object, required
    - `id` string, nullable, required: Paid plan id (basic/deluxe/pro), or null on trial/legacy.
    - `label` string, required
    - `source` 'paid' | 'trial' | 'trial_expired' | 'legacy', required: How the effective entitlements were derived.
    - `is_active` boolean, required: Whether reminders may flow (paid-active or live trial).
    - `is_trialing` boolean, required
    - `trial_days_left` number, nullable, required: Whole days left in the trial, or null when not trialing.
    - `trial_ends_at` number, nullable, required: Trial end, epoch ms (UTC), or null.
  - `entitlements` object, required
    - `sms_reminders` boolean, required
    - `signup_widget` boolean, required
    - `substitute_finder` boolean, required
    - `customized_reminders` boolean, required
    - `group_names` boolean, required
    - `reminders_per_shift` number, required
  - `reminder_mode` 'test' | 'live', required: THIS ACCOUNT's own reminder posture. 'test' is an agent sandbox — reminders reroute to the account owner's own address, never a real volunteer; 'live' reaches real volunteers. Agent-created accounts start 'test'; only a human can switch it to 'live' from the dashboard (never via this API or the MCP server). See also `effective_mode`.
  - `effective_mode` 'off' | 'test' | 'live', required: What actually happens at send time: the MOST RESTRICTIVE of this account's `reminder_mode` and the deployment-wide kill-switch. It is 'off' when sending is globally paused, 'test' when either this account or the deployment is in test, and 'live' only when BOTH are live. Read this to know whether a reminder would actually reach a volunteer.
  - `usage` object, required
    - `volunteers` object, required
      - `used` number, required: Active (non-deleted) volunteers.
      - `limit` number, required: Plan volunteer cap.
    - `schedules` object, required
      - `used` number, required: Active schedules (no enforced cap).

## Other responses

- `401`: Missing or invalid API key.
- `403`: The API key lacks a scope required by this endpoint.
- `404`: The requested resource does not exist.

---

[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)