API Documentation

Complete reference for the RemindUser API

Authentication

All API endpoints require an API key passed in the Authorization header.

Authorization: Bearer rm_your_api_key

Generate API keys from your dashboard.

Rate Limiting

60 requests per minute per API key. Exceeding this limit returns 429 Too Many Requests with a Retry-After header.

Endpoints

POST/api/remind

Create a new reminder.

Request body

{
  "title": "Follow up with client",
  "body": "Remember to send the proposal",
  "recipient": "user@example.com",
  "channel": "email",
  "fire_at": "2026-02-20T09:00:00Z",
  "repeat": "daily",
  "timezone": "America/New_York",
  "metadata": { "project_id": "abc123" }
}

Fields

title	Required. Max 200 chars.
recipient	Required. Email address or webhook URL.
fire_at	Required. ISO 8601 datetime, must be in the future.
channel	Optional. "email" (default), "webhook", or "sms".
body	Optional. Max 2000 chars.
repeat	Optional. "daily", "weekly", "monthly", or "custom".
timezone	Optional. IANA timezone (default: UTC).
metadata	Optional. Arbitrary JSON object.

GET/api/reminders

List reminders for the authenticated user.

Query parameters

status	Filter by status: pending, delivered, failed, cancelled.
limit	Max results (default 50, max 100).
offset	Pagination offset (default 0).

Example

curl https://reminduser.com/api/reminders?status=pending&limit=10 \
  -H "Authorization: Bearer rm_your_api_key"

PATCH/api/remind/:id

Update a pending reminder.

Request body (all fields optional)

{
  "title": "Updated title",
  "fire_at": "2026-02-21T10:00:00Z"
}

Only pending reminders can be updated. Returns 409 if the reminder is not pending.

DELETE/api/remind/:id

Cancel a pending reminder.

curl -X DELETE https://reminduser.com/api/remind/uuid-here \
  -H "Authorization: Bearer rm_your_api_key"

Sets status to "cancelled". Only pending reminders can be cancelled.

Error Codes

Status	Meaning
400	Validation error — check the details array
401	Missing or invalid API key
404	Reminder not found
409	Conflict — reminder is not in a modifiable state
429	Rate limit exceeded (60 req/min)
500	Internal server error

MCP Server

Use the RemindUser MCP server to give Claude and other AI assistants reminder capabilities.

// Install
npm install -g reminduser-mcp

// Add to Claude Desktop config (~/.claude/mcp.json)
{
  "mcpServers": {
    "reminduser": {
      "command": "reminduser-mcp",
      "args": ["stdio"],
      "env": {
        "REMINDUSER_API_KEY": "rm_your_api_key"
      }
    }
  }
}