Authentication
Authenticate API requests with a workspace API key sent as a bearer token.
Every API request needs an API key. Keys belong to a user and act in that user's workspace, with that user's role.
Create an API key
Open Settings → API keys in the dashboard.
Create a key and give it a name you'll recognise, such as the app that will use it.
Copy the key. It starts with ezqr_ and is shown only once.
API access is part of the Max plan. Requests from accounts on other plans get 403.
Send the key
Pass the key as a bearer token in the Authorization header:
curl https://ez-qr.com/api/v1/me \
-H "Authorization: Bearer ezqr_your_api_key"GET /me returns the user and workspace the key acts in, so it's a good connection test:
{
"userId": "u_8f2k",
"workspaceId": "org_1c9d",
"workspaceType": "organization",
"role": "admin"
}Keep keys safe
- Treat keys like passwords. Store them in environment variables or a secrets manager, never in client-side code or a repository.
- Use one key per integration so you can revoke one without breaking the others.
- Revoke a key in Settings → API keys as soon as you no longer need it or think it leaked.
Errors
| Status | When |
|---|---|
401 | The header is missing, the key is wrong, or it was revoked or expired |
403 | The account's plan doesn't include API access |
429 | The key went over the rate limit |
OAuth apps
Integrations such as the Canva app don't use API keys. People sign in with EZQR and approve access, and the app gets an OAuth access token for the REST API with only the permissions it asked for, such as qr:read and qr:write. Tokens for the API don't work with the MCP server, and the reverse.
AI assistants
AI apps don't use API keys. They connect to the MCP server by signing in with OAuth, or with the workspace MCP key, which only works with the MCP server.