API Authentication
Authenticate public API requests with RogerIQ API keys and scopes.
API Authentication
Use API keys for server-to-server integration with RogerIQ.
Header Options
bashcurl https://api.rogeriq.com/api/v1/projects/prj_123/conversations \ -H "Authorization: Bearer riq_your_key"
bashcurl https://api.rogeriq.com/api/v1/projects/prj_123/conversations \ -H "X-API-Key: riq_your_key"
Key Format
API keys must start with:
txtriq_
Scopes
| Scope | Required for |
|---|---|
read | Listing and reading conversations, messages, contacts, webhooks, and deliveries. |
write | Creating and updating conversations, messages, contacts, webhooks, and secrets. |
admin | Broad access where an endpoint accepts admin scope. |
Project Ownership
The API resolves the project in the URL and verifies that it belongs to the same organization as the API key. A valid key for one organization cannot access another organization's project.
Expiration
Keys can expire. Expired keys return 401 Unauthorized.
Best Practices
- Store API keys in a server-side secret manager.
- Use separate keys for production, staging, and local development.
- Rotate keys after employee offboarding or vendor changes.
- Use
readkeys for reporting-only integrations. - Never put an API key in the widget, form HTML, frontend bundle, or mobile app.