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

Компания

Проверка ключа: к какой компании он относится и какие у него права.

get/me— Проверить ключ

Ресурс `Me`

Поле	Описание
`company`object	Компания ключа.
`company.accountId`string \| null	Номер учётки, как в кабинете.
`company.name`string \| null	Название компании.
`scope`string	Набор прав: `read` — всё на чтение, `write` — ещё создание и изменение заявок, `custom` — выбранные права. · одно из: read, write, custom
`scopes`array<string>	Действующие права ключа по ресурсам.

Проверить ключ

get/api/v1/me

Компания, к которой относится ключ, и права ключа. Удобно первым запросом после выпуска ключа.

Право ключа: любой действующий ключ

curl https://app.chatneuron.ru/api/v1/me \
  -H "Authorization: Bearer cn_live_…"

Ответ 200

Ключ действует. Схема — Me.

JSON

{
  "company": {
    "accountId": "NC-123456",
    "name": "Ромашка"
  },
  "scope": "read",
  "scopes": [
    "leads:read",
    "dialogs:read",
    "customers:read",
    "employees:read",
    "connectors:read",
    "events:read"
  ]
}

Ошибки

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

Дальше

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