Account

Get the current account

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

get/api/v1/account

Request

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

Response

The account overview.

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.

Example response

{
  "account": {
    "id": 4021,
    "name": "Riverside Food Pantry",
    "time_zone": "America/Chicago"
  },
  "plan": {
    "id": "deluxe",
    "label": "Free trial"
  },
  "entitlements": {
    "reminders_per_shift": 2
  }
}

Changes

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