X-Api-Key header:
Scopes
Each key is granted a specific list of scopes, in the form{resource}.{operation} — for example members.create or form_responses.view. A request fails with missing_scope if the key wasn’t granted the scope that endpoint requires.
Not every resource supports every operation. Some are read-only (events.view, services.view, departments.view, forms.view); others support view, create, and sometimes update. Each endpoint’s reference page states exactly which scope it needs.
Key lifecycle
- Expiration — a key can be created with no expiry, or set to expire in 30, 90, or 365 days. An expired key fails every request with
key_expired. - Revocation — revoking a key from the dashboard is immediate and permanent. A revoked key fails every request with
key_revoked. Revoking never deletes the key’s history — it just stops it from authenticating.
Common authentication errors
See Errors for the full response shape.