Skip to main content

​
Overview

The Avoca Enterprise API gives enterprise customers and partners programmatic, read-only access to Avoca data: call records and transcripts, unified leads, coach (QA) evaluations, Simple Scheduler sessions and analytics, and outbound texting activity. For pushing data into Avoca (lead intake) and receiving real-time notifications from Avoca (event webhooks), see Webhooks & Lead Intake.

​
Base URL

All Enterprise API requests are made to:
Endpoint paths in this reference include the /api prefix (for example https://enterprise-api.avoca.ai/api/calls).

​
Authentication

Every request requires an API key sent as a Bearer token:
API keys use the format avoca_<64 hex characters>. Multi-team (enterprise_all_teams) keys must also identify the target team on v0 endpoints via the x-team-id header or team_id query parameter — v1 endpoints embed the team ID in the URL path instead. See Authentication for key types, permissions, and how to obtain keys.

​
API Versions

​
Pagination

Two pagination styles are used:
  • Offset pagination (most v0 endpoints): limit and offset query parameters. Responses include a pagination object with limit, offset, and has_more.
  • Cursor (keyset) pagination (v1 sessions, bookings, leads, and outbound feeds): pass the cursor value from a response’s pagination.cursor back as the cursor query parameter to fetch the next page. On the last page has_more is false and cursor is null.

​
Response Format

Successful responses return JSON with a data field, plus pagination and/or meta where applicable:

​
Errors

Errors use a consistent shape with an error field and, on newer endpoints, a human-readable message:

​
Rate Limiting

Rate limiting is not currently enforced on the Enterprise API. This may change in future versions; build clients to tolerate 429 responses.

​
Support