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

Deals

Sales opportunities moving through your pipeline stages (defaults: new → contacted → qualified → proposal → won — editable in the pipeline editor).

GET/api/v1/deals20 TOKENS
List deals

Returns deals, 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.
stagequeryenumFilter by stage key (your pipeline’s stages; defaults: new, contacted, qualified, proposal, won).
organization_idqueryuuidFilter by organization.
person_idqueryuuidFilter by contact person.
owner_idqueryuuidFilter by owner.
pipeline_idqueryuuidFilter by pipeline.
wonquerybooleanFilter by won flag.
Request
curl -X GET "https://app.averocrm.com/api/v1/deals" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": [
    {
      "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
      "title": "Horvat–Marin wedding — 40-room block",
      "stage": "proposal",
      "value": 18500,
      "currency": "USD",
      "probability": 60,
      "expected_close": "2026-08-15",
      "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
      "person_id": null,
      "owner_id": null,
      "source": "API",
      "won": false,
      "lost": false,
      "created_at": "2026-07-14T09:30:00.000Z",
      "updated_at": "2026-07-14T09:30:00.000Z"
    }
  ],
  "additional_data": {
    "pagination": {
      "start": 0,
      "limit": 100,
      "more_items_in_collection": false
    }
  }
}
GET/api/v1/deals/{id}2 TOKENS
Get a deal

Returns one deal by id.

NameInTypeDescription
id *pathuuidThe record's id.
Request
curl -X GET "https://app.averocrm.com/api/v1/deals/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "title": "Horvat–Marin wedding — 40-room block",
    "stage": "proposal",
    "value": 18500,
    "currency": "USD",
    "probability": 60,
    "expected_close": "2026-08-15",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "owner_id": null,
    "source": "API",
    "won": false,
    "lost": false,
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
POST/api/v1/deals10 TOKENS
Create a deal

Creates a deal. Unknown fields are rejected.

NameInTypeDescription
title *bodystringDeal title.
stagebodyenumA stage key from your pipeline (defaults: new | contacted | qualified | proposal | won). Default: the first stage.
valuebodynumberDeal value.
currencybodystringCurrency code. Default USD.
organization_idbodyuuidLinked organization.
person_idbodyuuidLinked contact person.
owner_idbodyuuidOwning sales rep.
expected_closebodydateExpected close date (YYYY-MM-DD).
probabilitybodyintegerWin probability, 0–100.
sourcebodystringWhere the deal came from.
locationbodystringProperty location.
keysbodyintegerNumber of keys (rooms/units).
wonbodybooleanMark as won.
lostbodybooleanMark as lost.
lost_reasonbodystringWhy the deal was lost.
pipeline_idbodyuuidPipeline. Defaults to the first pipeline.
Request
curl -X POST "https://app.averocrm.com/api/v1/deals" \
  -H "x-api-token: $AVERO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Horvat–Marin wedding — 40-room block","stage":"proposal","value":18500,"probability":60}'
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "title": "Horvat–Marin wedding — 40-room block",
    "stage": "proposal",
    "value": 18500,
    "currency": "USD",
    "probability": 60,
    "expected_close": "2026-08-15",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "owner_id": null,
    "source": "API",
    "won": false,
    "lost": false,
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
PATCH/api/v1/deals/{id}10 TOKENS
Update a deal

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

NameInTypeDescription
id *pathuuidThe record's id.
titlebodystringDeal title.
stagebodyenumA stage key from your pipeline (defaults: new | contacted | qualified | proposal | won). Default: the first stage.
valuebodynumberDeal value.
currencybodystringCurrency code. Default USD.
organization_idbodyuuidLinked organization.
person_idbodyuuidLinked contact person.
owner_idbodyuuidOwning sales rep.
expected_closebodydateExpected close date (YYYY-MM-DD).
probabilitybodyintegerWin probability, 0–100.
sourcebodystringWhere the deal came from.
locationbodystringProperty location.
keysbodyintegerNumber of keys (rooms/units).
wonbodybooleanMark as won.
lostbodybooleanMark as lost.
lost_reasonbodystringWhy the deal was lost.
pipeline_idbodyuuidPipeline. Defaults to the first pipeline.
Request
curl -X PATCH "https://app.averocrm.com/api/v1/deals/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Horvat–Marin wedding — 40-room block"}'
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "title": "Horvat–Marin wedding — 40-room block",
    "stage": "proposal",
    "value": 18500,
    "currency": "USD",
    "probability": 60,
    "expected_close": "2026-08-15",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "owner_id": null,
    "source": "API",
    "won": false,
    "lost": false,
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
DELETE/api/v1/deals/{id}6 TOKENS
Delete a deal

Deletes a deal permanently.

NameInTypeDescription
id *pathuuidThe record's id.
Request
curl -X DELETE "https://app.averocrm.com/api/v1/deals/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
}