Developers

Avero API

A REST API over your CRM data — deals, persons, organizations, activities and notes. Build your own integrations, sync your stack, automate your pipeline.

Create an API key

Leads

Pre-deal opportunities in the Leads Inbox — qualify them, then convert the right ones into deals.

GET/api/v1/leads20 TOKENS
List leads

Returns leads, newest first. Supports pagination and the filters below.

NameInTypeDescription
startqueryintegerPagination offset. Default 0.
limitqueryintegerItems per page. Default 100, max 500.
updated_sincequerydatetimeOnly records updated at or after this ISO 8601 timestamp — for incremental sync. Datetimes must include a timezone offset (e.g. 2026-07-15T10:00:00Z); date-only values are read as UTC.
organization_idqueryuuidFilter by organization.
person_idqueryuuidFilter by contact person.
owner_idqueryuuidFilter by owner.
titlequerystringFilter by title (partial match).
Request
curl -X GET "https://app.averocrm.com/api/v1/leads" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": [
    {
      "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
      "title": "Meridian Resort — group booking enquiry",
      "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
      "person_id": null,
      "owner_id": null,
      "value": 12000,
      "currency": "EUR",
      "expected_close": "2026-09-30",
      "source_channel": "Web forms",
      "source_channel_id": null,
      "origin": "api",
      "visible_to": "everyone",
      "archived_at": null,
      "converted_deal_id": null,
      "created_at": "2026-08-23T09:30:00.000Z",
      "updated_at": "2026-08-23T09:30:00.000Z"
    }
  ],
  "additional_data": {
    "pagination": {
      "start": 0,
      "limit": 100,
      "more_items_in_collection": false
    }
  }
}
GET/api/v1/leads/{id}2 TOKENS
Get a lead

Returns one lead by id.

NameInTypeDescription
id *pathuuidThe record's id.
Request
curl -X GET "https://app.averocrm.com/api/v1/leads/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "title": "Meridian Resort — group booking enquiry",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "owner_id": null,
    "value": 12000,
    "currency": "EUR",
    "expected_close": "2026-09-30",
    "source_channel": "Web forms",
    "source_channel_id": null,
    "origin": "api",
    "visible_to": "everyone",
    "archived_at": null,
    "converted_deal_id": null,
    "created_at": "2026-08-23T09:30:00.000Z",
    "updated_at": "2026-08-23T09:30:00.000Z"
  },
  "additional_data": null
}
POST/api/v1/leads10 TOKENS
Create a lead

Creates a lead. Unknown fields are rejected.

NameInTypeDescription
title *bodystringLead title.
organization_idbodyuuidLinked organization.
person_idbodyuuidLinked contact person.
owner_idbodyuuidOwning sales rep.
valuebodynumberLead value.
currencybodystringCurrency code. Default EUR.
expected_closebodydateExpected close date (YYYY-MM-DD).
source_channelbodystringWhere the lead came from (e.g. Web forms).
source_channel_idbodystringExternal source identifier.
visible_tobodyenumeveryone | owner. Default everyone.
Request
curl -X POST "https://app.averocrm.com/api/v1/leads" \
  -H "x-api-token: $AVERO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Meridian Resort — group booking enquiry","value":12000,"currency":"EUR"}'
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "title": "Meridian Resort — group booking enquiry",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "owner_id": null,
    "value": 12000,
    "currency": "EUR",
    "expected_close": "2026-09-30",
    "source_channel": "Web forms",
    "source_channel_id": null,
    "origin": "api",
    "visible_to": "everyone",
    "archived_at": null,
    "converted_deal_id": null,
    "created_at": "2026-08-23T09:30:00.000Z",
    "updated_at": "2026-08-23T09:30:00.000Z"
  },
  "additional_data": null
}
PATCH/api/v1/leads/{id}10 TOKENS
Update a lead

Updates the given fields of a lead. PUT is accepted as an alias.

NameInTypeDescription
id *pathuuidThe record's id.
titlebodystringLead title.
organization_idbodyuuidLinked organization.
person_idbodyuuidLinked contact person.
owner_idbodyuuidOwning sales rep.
valuebodynumberLead value.
currencybodystringCurrency code. Default EUR.
expected_closebodydateExpected close date (YYYY-MM-DD).
source_channelbodystringWhere the lead came from (e.g. Web forms).
source_channel_idbodystringExternal source identifier.
visible_tobodyenumeveryone | owner. Default everyone.
Request
curl -X PATCH "https://app.averocrm.com/api/v1/leads/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Meridian Resort — group booking enquiry"}'
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "title": "Meridian Resort — group booking enquiry",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "owner_id": null,
    "value": 12000,
    "currency": "EUR",
    "expected_close": "2026-09-30",
    "source_channel": "Web forms",
    "source_channel_id": null,
    "origin": "api",
    "visible_to": "everyone",
    "archived_at": null,
    "converted_deal_id": null,
    "created_at": "2026-08-23T09:30:00.000Z",
    "updated_at": "2026-08-23T09:30:00.000Z"
  },
  "additional_data": null
}
DELETE/api/v1/leads/{id}6 TOKENS
Delete a lead

Deletes a lead permanently.

NameInTypeDescription
id *pathuuidThe record's id.
Request
curl -X DELETE "https://app.averocrm.com/api/v1/leads/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10"
  },
  "additional_data": null
}
POST/api/v1/leads/{id}/convert10 TOKENS
Convert a lead to a deal

Creates a deal from the lead (carrying over its contact, organization, value, labels and source), moves the lead's notes/activities/emails onto the new deal, and archives the lead. Returns the new deal.

NameInTypeDescription
id *pathuuidThe record's id.
Request
curl -X POST "https://app.averocrm.com/api/v1/leads/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10/convert" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "title": "Meridian Resort — group booking enquiry",
    "stage": "new",
    "value": 12000,
    "currency": "EUR"
  },
  "additional_data": null
}