Skip to main content

API Keys

All API requests require authentication using an API key. Include your key in the Authorization header using the Bearer scheme.

Authentication Header

API Key Format

Doppel API keys follow a specific format:

Making Authenticated Requests

Scopes

API keys have specific scopes that determine what resources they can access:
By default, API keys are created with all read scopes enabled. Contact your account manager if you need to modify scopes.

Clinic Restrictions

API keys can optionally be restricted to specific clinics. When restricted:
  • The key can only access data for the specified clinics
  • Requests for other clinics will return empty results
  • This is useful for multi-location integrations

Security Best Practices

Treat your API key like a password. Never expose it publicly.

Do’s

  • Store API keys in environment variables
  • Use server-side code to make API calls
  • Rotate keys periodically
  • Use separate keys for development and production

Don’ts

  • Never commit API keys to version control
  • Never expose keys in client-side JavaScript
  • Never share keys via email or chat
  • Never use production keys for testing

Error Responses

Missing Authorization Header

Invalid API Key

Expired API Key

Getting an API Key

To obtain an API key:
  1. Contact your Doppel account manager
  2. Specify your use case and required scopes
  3. Receive your key via secure channel
  4. Store it securely and start integrating!