Skip to main content
Enterprise API keys allow you to access your Avoca data programmatically. From the dashboard, you can generate API keys, configure which data columns are exposed, and reference inline API documentation — all without leaving the settings page.
Enterprise API key management requires the Enterprise API Keys permission. If you do not see this option in your settings, contact your Avoca representative.

Accessing API key settings

Navigate to Settings → API Keys in your enterprise dashboard sidebar. The page has three tabs: API Keys, Data Configuration, and Documentation.

Managing API keys

Create an API key

1

Open the API Keys tab

Go to Settings → API Keys and select the API Keys tab.
2

Click Create API Key

Click Create API Key to open the creation dialog.
3

Configure the key

Enter a name for the key, select the team it should be anchored to, and choose the permissions you want to grant. Available permissions include read access to calls, coach data, leads, and teams.
4

Copy the key

After creation, copy the API key immediately. For security, the full key is only shown once. You will see a masked version of the key afterward.

View existing keys

The API Keys tab displays a table of all keys with:
  • Key name and masked prefix
  • Granted permissions
  • Creation date
  • Last used date and usage count

Revoke a key

To revoke an API key, click the revoke action on the key row. Revoked keys immediately stop working for all API requests.
Revoking a key is permanent. Any applications using the key will lose access immediately.

Configuring data columns

The Data Configuration tab lets you control what data is returned by the API:
  • Allowed columns — Toggle which data columns are included in API responses.
  • Assistant mappings — Map assistant IDs to human-readable display names so API consumers see meaningful labels instead of internal identifiers. You can set a default fallback value for unmapped assistants.

API documentation

The Documentation tab provides an inline reference for all available API endpoints:
EndpointDescription
GET /api/callsList calls with filters and pagination.
GET /api/calls/:idGet details for a specific call.
GET /api/calls/:id/transcriptGet the transcript for a specific call.
GET /api/coachList Coach-evaluated calls.
GET /api/coach/:idGet Coach details for a specific call.
GET /api/coach/rubricsList configured rubrics.
GET /api/leadsList leads with filters and pagination.
Simple Scheduler endpoints are also available for teams using the scheduling product.
Last modified on April 8, 2026