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

Notes

Free-form notes attached to deals, persons or organizations.

GET/api/v1/notes20 TOKENS
List notes

Returns notes, 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.
deal_idqueryuuidFilter by deal.
person_idqueryuuidFilter by person.
organization_idqueryuuidFilter by organization.
Request
curl -X GET "https://app.averocrm.com/api/v1/notes" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": [
    {
      "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
      "body": "Prefers a call after 3pm. Renovation finishes in September.",
      "deal_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
      "person_id": null,
      "organization_id": null,
      "pinned": 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/notes/{id}2 TOKENS
Get a note

Returns one note by id.

NameInTypeDescription
id *pathuuidThe record's id.
Request
curl -X GET "https://app.averocrm.com/api/v1/notes/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "body": "Prefers a call after 3pm. Renovation finishes in September.",
    "deal_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "organization_id": null,
    "pinned": false,
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
POST/api/v1/notes10 TOKENS
Create a note

Creates a note. Unknown fields are rejected.

NameInTypeDescription
body *bodystringNote text.
deal_idbodyuuidLinked deal.
person_idbodyuuidLinked person.
organization_idbodyuuidLinked organization.
owner_idbodyuuidAuthor (sales rep).
pinnedbodybooleanPin to the top of the timeline.
Request
curl -X POST "https://app.averocrm.com/api/v1/notes" \
  -H "x-api-token: $AVERO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body":"Prefers a call after 3pm.","deal_id":"7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a"}'
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "body": "Prefers a call after 3pm. Renovation finishes in September.",
    "deal_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "organization_id": null,
    "pinned": false,
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
PATCH/api/v1/notes/{id}10 TOKENS
Update a note

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

NameInTypeDescription
id *pathuuidThe record's id.
bodybodystringNote text.
deal_idbodyuuidLinked deal.
person_idbodyuuidLinked person.
organization_idbodyuuidLinked organization.
owner_idbodyuuidAuthor (sales rep).
pinnedbodybooleanPin to the top of the timeline.
Request
curl -X PATCH "https://app.averocrm.com/api/v1/notes/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body":"Prefers a call after 3pm."}'
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "body": "Prefers a call after 3pm. Renovation finishes in September.",
    "deal_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "person_id": null,
    "organization_id": null,
    "pinned": false,
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
DELETE/api/v1/notes/{id}6 TOKENS
Delete a note

Deletes a note permanently.

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