Quickstart

1. Sign up and create a workspace

Create your account in the application, verify your email, and create your first workspace during onboarding. Everything in the API belongs to a workspace.

2. Create an API key

As a workspace owner, go to Settings → API Keys, create a key, and copy the secret — it is shown exactly once. Store it in your secret manager, never in code.

3. Make your first call

curl \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.reminix.com/v1/workspace

{ "id": "…", "name": "Your Workspace" }

That response is the API’s “who am I” — a healthy integration smoke test.

Next steps

• Authentication — how keys and personal access tokens work, and how to rotate them.
• Webhooks — push events to your systems.
• The TypeScript SDK and the command line.
• Errors & API rate limits and Pagination.
• The interactive API reference — every endpoint, schema, and a try-it console — lives at api.reminix.com/v1/docs, generated from the same definitions that validate requests, so it is always current.