Getting Started
Authentication
Every Callix API request must include a Bearer token in the Authorization header. Tokens are API keys you generate in the dashboard.
Sending the token
bash
curl https://<deployment>.convex.site/api/v1/prospects \
-H "Authorization: Bearer callix_<64-hex-chars>"Requests without a valid token return 401 Unauthorized. Revoked keys also return 401.
Generating a key
- 1Open the Callix dashboard and navigate to Settings → API Keys.
- 2Click New Key, give it a descriptive label (e.g. "Zapier Integration"), and confirm.
- 3Copy the raw token shown exactly once. It will never be displayed again. Store it in a secrets manager (e.g. Vercel env vars, AWS Secrets Manager).
How keys are stored
Only a SHA-256 hash of the raw token is stored in Callix. The raw value is never persisted — if you lose it, revoke the key and create a new one.
apiKeys table
accountIdId<"accounts">Account this key belongs tokeyHashstringSHA-256 of the raw token — raw token never storedlabelstringUser-defined namecreatedAtnumberUnix mslastUsedAtnumber?Updated on every valid requestrevokedAtnumber?Set when revoked; absent = activeScopes
All v1 API keys have full account access. Per-resource scoping (read-only keys, write-only keys) is planned for v2.
Revoking a key
Revoke a key from Settings → API Keys in the dashboard. Revoked keys return 401 immediately on all subsequent requests. Revoking a key does not delete data — it only stops further API access.
