Skip to content
Docs · Authentication

Get started

Authentication

Every request (except the OpenAPI spec) needs an API key, sent as a Bearer token.

curl "https://www.kindredoo.com/api/v1/events?limit=5" \
  -H "Authorization: Bearer $KINDRED_API_KEY"

Get a key

Keys belong to your Kindred account: log in (or sign up) and open the developer dashboard. Verify your email, then create a key and give it a name you'll recognise (“Production site”, “Staging”). A key looks like kd_live_ followed by 32 letters and digits.

The full key is shown once

We only keep a fingerprint of it, so nobody (us included) can show it again. If you lose it, revoke it and create a new one.

Keep it secret

  • Call the API from your server or build step and cache the results; send your visitors your own pages or JSON.
  • Store the key in an environment variable or secret manager, never in source control.
  • Browser calls work (CORS allows any origin for GET), but anyone can read a key shipped in front-end code and spend your quota. Use that only for prototypes.
  • Use one key per app or environment, so you can revoke one without touching the others.

Rotate and revoke

To rotate: create a new key, deploy it, then revoke the old one in the dashboard. Revoking takes effect immediately. The dashboard shows when each key was last used. Free accounts can hold 3 active keys, Pro 10.

When the key is wrong

A missing header answers 401 missing_api_key; an unknown, mistyped or revoked key answers 401 invalid_api_key. Both use the standard error envelope:

401401 Unauthorized
{
  "error": {
    "code": "invalid_api_key",
    "message": "This API key is not valid. It may be mistyped or revoked."
  }
}

Start building with Kindred events

Create a free key in a minute with your Kindred account. Upgrade to Pro when you go commercial.