Enabling API Access
API access is disabled by default for all Doozy workspaces. Before any API keys can be generated, an Admin must enable API access:1
Open Doozy Settings
Navigate to your Doozy dashboard and open Settings.
2
Go to Security
Select the Security page from the settings menu.
3
Enable API Access
Toggle on the API Access option to allow API key generation.
Creating an API Key
Once API access is enabled, Admins and Managers can generate API keys:1
Open API Settings
In your Doozy dashboard, navigate to the API keys section.
2
Generate New Key
Click Generate API Key to create a new key.
3
Copy and Store Securely
Copy your API key immediately. For security reasons, the full key is only shown once.
Using Your API Key
Include your API key in thex-api-key header with every request:
API Key Format
Doozy API keys follow this format:Access Scoping
API keys inherit the permissions of the user who created them. This means:- You can only access quizzes, surveys, and other resources that you have permission to view as an Admin or Manager
- If you are removed as an admin from a quiz or survey, your API key will immediately lose access to that resource
- Different users’ API keys may have access to different resources based on their individual permissions
If you need to access data across your entire workspace, ensure the user generating the API key has appropriate permissions for all resources.
Rotating API Keys
To rotate your API key (recommended periodically for security):1
Generate a New Key
Create a new API key following the steps above.
2
Update Your Integrations
Replace the old API key with the new one in all your integrations and scripts.
3
Revoke the Old Key
Once all integrations are updated, delete the old API key from your Doozy dashboard.
Rate Limiting
The Doozy API enforces rate limits to ensure fair usage:
When you exceed the rate limit, the API returns a
429 Too Many Requests response. See the Errors page for details on handling this.
Rate limits are applied per API key. If you need higher limits, please contact us at hello@doozy.live.