Get started
Authentication
Every request carries a workspace API key.
API keys
Create a key in the app under Integrations → API, or with Create an API key. A key belongs to one workspace and sees only that workspace’s brands, forms and responses. A key made by a member limited to some brands sees only those (see Brand access).
The key is shown only once, when you create it, so store it somewhere safe.
Sending the key
Send the key with every request, in the Authorization header:
Header
Authorization: Bearer fk_…Base URL
https://careful-sparrow-950.convex.siteEvery path starts with /v1.
Revoking a key
Revoke a key in the app, or with Revoke an API key. Requests that use it get 401 from then on.