Authentication
Create an API key in your Avero workspace under Settings → Personal preferences → API and send it with every request in the x-api-token header — Authorization: Bearer is accepted as an alias. Keys are shown once at creation and can be revoked at any time.
curl "https://app.averocrm.com/api/v1/deals" \ -H "x-api-token: $AVERO_API_TOKEN"
Base URL
https://app.averocrm.com/api/v1
Response envelope
Every response is wrapped in the same envelope. Errors carry a human-readable message.
{
"success": true,
"data": {
"…": "…"
},
"additional_data": {
"pagination": {
"start": 0,
"limit": 100,
"more_items_in_collection": false
}
}
}{
"success": false,
"error": "Not found",
"error_info": "See averocrm.com/developers",
"data": null,
"additional_data": null
}Pagination
List endpoints use offset pagination via start and limit query parameters (default limit 100, max 500). When more items exist, additional_data.pagination includes more_items_in_collection: true and next_start— pass it as the next request's start.
curl "https://app.averocrm.com/api/v1/persons?start=100&limit=100" \ -H "x-api-token: $AVERO_API_TOKEN"
Rate limits & token costs
Usage is metered in tokens. Your workspace has a daily token budget based on its billing plan (30,000 on Solo, 150,000 on Team), which resets at midnight UTC — track it live on your workspace's Usage page. Each request costs tokens by operation type:
A burst limit of 40 requests per 2 seconds also applies. Every response carries x-ratelimit-limit, x-ratelimit-remaining, x-ratelimit-reset and x-daily-tokens-left headers; once the budget is spent, requests return 429 until the daily reset.
Errors
Syncing data
For incremental sync, poll list endpoints with updated_since (inclusive — store the latest updated_at you saw and dedupe by id). Deletions never appear in polls; use webhooks to hear about them (and to skip polling entirely).
Resources
Each resource supports the same five operations — list, get, create, update and delete.
- Deals — Sales opportunities moving through your pipeline stages (defaults: new → contacted → qualified → proposal → won — editable in the pipeline editor).
- Persons — Contact people. One of full_name, first_name/last_name or email is required on create.
- Organizations — The companies and groups your deals are sold to — corporate accounts, agencies and event planners.
- Activities — Calls, meetings, tasks and other scheduled work, linked to deals, persons or organizations.
- Notes — Free-form notes attached to deals, persons or organizations.