ChatNeuron
Начать бесплатно
Разделы

справочник API · v1

Клиенты

Клиенты компании — одна карточка на человека по всем каналам — и контрагенты: компании-клиенты и поставщики.

Ресурс Customer

ПолеОписание
idstringId клиента.
namestring | nullИмя, если известно.
phonesarray<string>Телефоны.
emailsarray<string>Почта.
counterpartyIdstring | nullКомпания клиента (B2B) — id из GET /counterparties.
firstSeenAtstring (date-time)Первое обращение.
lastEventAtstring | null (date-time)Последняя активность.

Список клиентов

get/api/v1/customers

Клиенты компании из модуля «Клиенты», новые первыми. since — по последней активности клиента. Склеенные и удалённые по запросу карточки не отдаются.

Право ключа: Клиенты и контрагенты · customers:read

curl "https://app.chatneuron.ru/api/v1/customers?limit=50&since=2026-10-01T00%3A00%3A00Z" \
  -H "Authorization: Bearer cn_live_…"

Параметры запроса

ПараметрОписание
limitintegerСколько записей на странице. · 1–100 · по умолчанию 50
sincestring (date-time)Брать записи с этой даты (ISO 8601).
cursorstringnextCursor из прошлого ответа.

Ответ 200

Страница клиентов.

JSON
{
  "data": [
    {
      "id": "cmw1c7k2a0001aaaa",
      "name": "Анна Смирнова",
      "phones": [
        "+79991234567"
      ],
      "emails": [],
      "counterpartyId": null,
      "firstSeenAt": "2026-10-02T11:20:00.000Z",
      "lastEventAt": "2026-10-27T09:16:12.000Z"
    }
  ],
  "nextCursor": null
}

Ошибки

СтатусcodeКогда
400invalid_requestНекорректные параметры или тело запроса.
401unauthorizedНет ключа, ключ неверный или отозван.
403forbiddenУ ключа нет нужного права — оно указано в тексте ошибки.
429rate_limitedБольше 120 запросов в минуту. Повторите через Retry-After секунд.

Список контрагентов

get/api/v1/counterparties

Компании, с которыми работает ваша компания: клиенты и поставщики, с ИНН и доменами почты. Новые первыми.

Право ключа: Клиенты и контрагенты · customers:read

curl "https://app.chatneuron.ru/api/v1/counterparties?limit=50&since=2026-10-01T00%3A00%3A00Z" \
  -H "Authorization: Bearer cn_live_…"

Параметры запроса

ПараметрОписание
limitintegerСколько записей на странице. · 1–100 · по умолчанию 50
sincestring (date-time)Брать записи с этой даты (ISO 8601).
cursorstringnextCursor из прошлого ответа.

Ответ 200

Страница контрагентов.

JSON
{
  "data": [
    {
      "id": "cmw1d0q3b0002bbbb",
      "kind": "client",
      "name": "ООО «Ромашка»",
      "inn": "1655123456",
      "kpp": "165501001",
      "domains": [
        "romashka.ru"
      ],
      "createdAt": "2026-09-20T08:00:00.000Z"
    }
  ],
  "nextCursor": null
}

Ошибки

СтатусcodeКогда
400invalid_requestНекорректные параметры или тело запроса.
401unauthorizedНет ключа, ключ неверный или отозван.
403forbiddenУ ключа нет нужного права — оно указано в тексте ошибки.
429rate_limitedБольше 120 запросов в минуту. Повторите через Retry-After секунд.

Дальше

Общие правила — ключи, лимиты, ошибки, страницы — в обзоре API. Узнавать о событиях сразу, без опроса, — через исходящие вебхуки.