API Reference
Authentication
How to authenticate with the Voxares API using API keys
Authentication
The Voxares API uses API keys for authentication. Every request must include your key in the Authorization header.
API key format
API keys follow the format vox-<id>-<secret>. The full key is shown only once at creation, so store it securely.
Using your key
Include the key as a Bearer token in every request:
curl -X GET "https://api.voxares.com/api/v1/integration/patients" \
-H "Authorization: Bearer vox-YOUR-API-KEY"
Creating an API key
- In the Voxares dashboard, go to Settings > API Keys
- Click Create API Key
- Enter a name (e.g. "My CRM Integration")
- Copy the key immediately. It cannot be retrieved later
Store your API key securely. Do not commit it to source control or expose it in client-side code. If a key is compromised, delete it immediately and create a new one.
Practice context
Each API key is bound to a specific practice. All resources you create or query through the key are automatically scoped to that practice, so you never need to send a practiceId.