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

Persons

Contact people. One of full_name, first_name/last_name or email is required on create.

GET/api/v1/persons20 TOKENS
List persons

Returns persons, 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.
emailquerystringFilter by email (partial match).
organization_idqueryuuidFilter by organization.
Request
curl -X GET "https://app.averocrm.com/api/v1/persons" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": [
    {
      "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
      "first_name": "Ana",
      "last_name": "Kovač",
      "full_name": "Ana Kovač",
      "role": "Events Manager",
      "email": "ana@northwind.io",
      "phone": "+385 91 234 5678",
      "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
      "source": "API",
      "marketing_status": "no_consent",
      "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/persons/{id}2 TOKENS
Get a person

Returns one person by id.

NameInTypeDescription
id *pathuuidThe record's id.
Request
curl -X GET "https://app.averocrm.com/api/v1/persons/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN"
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "first_name": "Ana",
    "last_name": "Kovač",
    "full_name": "Ana Kovač",
    "role": "Events Manager",
    "email": "ana@northwind.io",
    "phone": "+385 91 234 5678",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "source": "API",
    "marketing_status": "no_consent",
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
POST/api/v1/persons10 TOKENS
Create a person

Creates a person. Unknown fields are rejected.

NameInTypeDescription
first_namebodystringFirst name.
last_namebodystringLast name.
full_namebodystringFull name. Computed from first/last or email when omitted.
emailbodystringEmail address.
phonebodystringPhone number.
rolebodystringJob title.
linkedinbodystringLinkedIn URL.
organization_idbodyuuidLinked organization.
sourcebodystringWhere the contact came from.
marketing_statusbodyenumno_consent | subscribed | unsubscribed.
Request
curl -X POST "https://app.averocrm.com/api/v1/persons" \
  -H "x-api-token: $AVERO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Ana","last_name":"Kovač","email":"ana@northwind.io","role":"Events Manager"}'
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "first_name": "Ana",
    "last_name": "Kovač",
    "full_name": "Ana Kovač",
    "role": "Events Manager",
    "email": "ana@northwind.io",
    "phone": "+385 91 234 5678",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "source": "API",
    "marketing_status": "no_consent",
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
PATCH/api/v1/persons/{id}10 TOKENS
Update a person

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

NameInTypeDescription
id *pathuuidThe record's id.
first_namebodystringFirst name.
last_namebodystringLast name.
full_namebodystringFull name. Computed from first/last or email when omitted.
emailbodystringEmail address.
phonebodystringPhone number.
rolebodystringJob title.
linkedinbodystringLinkedIn URL.
organization_idbodyuuidLinked organization.
sourcebodystringWhere the contact came from.
marketing_statusbodyenumno_consent | subscribed | unsubscribed.
Request
curl -X PATCH "https://app.averocrm.com/api/v1/persons/9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10" \
  -H "x-api-token: $AVERO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Ana"}'
Response
{
  "success": true,
  "data": {
    "id": "9b2f7e34-1c5d-4a8e-b7f0-3d2a6c9e8f10",
    "first_name": "Ana",
    "last_name": "Kovač",
    "full_name": "Ana Kovač",
    "role": "Events Manager",
    "email": "ana@northwind.io",
    "phone": "+385 91 234 5678",
    "organization_id": "7c1e5a90-2b4f-4d3c-9e8a-6f0b1d2c3e4a",
    "source": "API",
    "marketing_status": "no_consent",
    "created_at": "2026-07-14T09:30:00.000Z",
    "updated_at": "2026-07-14T09:30:00.000Z"
  },
  "additional_data": null
}
DELETE/api/v1/persons/{id}6 TOKENS
Delete a person

Deletes a person permanently.

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