Creating an API Key
To begin using the RevRing API, you must first create an API Key from the dashboard. API Keys are sensitive credentials, so ensure to store them securely and limit access.Create an API Key
Create a new API Key from the RevRing Dashboard
Full access or read-only
Each key has an access level, chosen when it is created:- Full access: every endpoint, including creating agents, placing calls and deleting things.
- Read-only: reads only (
GETendpoints and the batch lookups). Any request that would create, change or delete something is refused with403 read_only_key. Use read-only keys for reporting, dashboards and integrations that only need to read.
Teammates with view-only access
Roles for the people in your organization are set on the dashboard’s Users page (admins only). A teammate with the viewer role sees everything on the dashboard and can change nothing: any change they attempt is refused with403 viewer_role. Admins and members can make changes; only admins manage users, API keys and billing.
Authentication
All API endpoints are authenticated using thex-api-key header: