Skip to content

Getting started in 5 minutes

Base URL: https://app.rieck.nu/api/v1

API access is part of the Advanced plan. Without it, keys cannot be issued and requests answer 403 api_not_included — contact Rieck to upgrade.

  1. An organisation administrator creates an API key under Admin → API keys (/admin/api-keys). The raw key is shown once — store it in your secret manager.
  2. Every request sends it as a bearer token:
Terminal window
curl https://app.rieck.nu/api/v1 \
-H "Authorization: Bearer rk_live_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

The discovery endpoint returns your API version, organisation id and the scopes your key carries — use it as a connectivity/health check.

Keys come in two environments, encoded in the prefix: rk_live_… and rk_test_…. Keys can be rotated (new key issued, old revoked atomically) and revoked with immediate effect from the same admin page.

Bootstrapping at signup — an API cannot issue its own first key, but the signup flow can: keep the signup token from POST /api/new, let the human confirm their e-mail and complete the welcome step, then exchange the token once:

Terminal window
curl -X POST https://app.rieck.nu/api/onboarding/api-key \
-H "Authorization: Bearer $SIGNUP_TOKEN"

201 returns the organisation’s first key (narrow scopes — never members/settings/ webhooks; get broader keys in the portal). 409 is a stable pending state (pending_confirmation / pending_plan — API access requires the Advanced plan / already_bootstrapped). The exchange window is 30 days and only works while the organisation has no keys yet.