Error Response Format
When an error occurs, the API returns a JSON response with anerror object containing a code and message:
Error Codes
| HTTP Status | Error Code | Description |
|---|---|---|
400 | bad_request | The request was malformed or missing required parameters |
401 | invalid_key | The API key is missing, invalid, or has been revoked |
403 | forbidden | The API key doesn’t have permission to access this resource |
404 | not_found | The requested resource doesn’t exist or you don’t have access to it |
429 | rate_limited | You’ve exceeded the rate limit of 1,000 requests per hour |
500 | internal_error | An unexpected error occurred on our servers |
Handling Errors
Invalid API Key (401)
- The API key is missing from the request
- The API key format is incorrect
- The API key has been revoked or deleted
x-api-key header.
Forbidden (403)
- Your user account doesn’t have permission to access this resource
- You were removed as an admin/manager from the quiz or survey
Not Found (404)
- The resource ID is incorrect
- The resource has been deleted
- You don’t have access to view this resource
Rate Limited (429)
- You’ve exceeded 1,000 requests per hour
Internal Error (500)
- An unexpected error on our servers