# Справочник API

Перечень операций публичного API: разделы, страницы документации и сигнатуры. Состав и порядок те же, что в интерактивном [справочнике](/docs/api-reference) и в боковом меню. Общий формат запросов и ответов описан в разделе [Обзор API](/docs/entity-api).

Каждая строка ведёт на страницу операции с параметрами, примерами и кодами ошибок. Обзорные страницы, которые не описывают отдельную операцию, достижимы со страниц своих разделов. Скоуп указан рядом с названием раздела там, где его требуют карточки справочника.

<!-- BEGIN GENERATED: api-reference-hub -->

## Основы API

### [Batch API](/docs/batch) · `bizproc` `booking` `calendar` `catalog` `crm` `department` `disk` `documentgenerator` `humanresources` `imopenlines` `landing` `mail` `sale` `sonet_group` `task` `tasks` `telephony` `user`

- [Пакетные вызовы](/docs/batch) — 47 операций

## Ключи и доступ

### [Пробный период Маркета](/docs/activate-market-trial)

- [Активировать пробный период Маркета](/docs/activate-market-trial) — `POST /v1/portals/*/activate-market-trial`

### [Ключи и авторизация](/docs/keys-auth)

- [Самоописание ключа](/docs/keys-auth/me) — `GET /v1/me`
- [Справочник API для модели](/docs/keys-auth/guide) — `GET /v1/guide`
- [Авторизация пользователей приложения](/docs/keys-auth/oauth) — 6 операций

### [Partner Connect](/docs/partner-connect)

- [Partner Connect](/docs/partner-connect) — `GET /v1/connect/authorize` `POST /v1/connect/token` `POST /v1/connect/revoke`

## Приложения

### [Чертежи приложений](/docs/app-blueprints)

- [Чертежи приложений](/docs/app-blueprints) — `GET /v1/app/blueprints/*`

### [Витрина приложений](/docs/applications)

- [Список приложений](/docs/applications/list) — `GET /v1/applications`
- [Карточка приложения](/docs/applications/get) — `GET /v1/applications/*`

### [Приложения и публикация](/docs/apps) · `placement`

- [Места встраивания](/docs/apps/placements) — обзор подраздела
- [Привязанные места](/docs/apps/placements/list) — `GET /v1/placements`
- [Доступные места](/docs/apps/placements/available) — `GET /v1/placements/available`
- [Привязать место встраивания](/docs/apps/placements/bind) — `POST /v1/placements/bind`
- [Отвязать место встраивания](/docs/apps/placements/unbind) — `POST /v1/placements/unbind`
- [Список приложений](/docs/apps/list) — `GET /v1/apps`
- [Создать приложение](/docs/apps/create) — `POST /v1/apps`
- [Данные приложения](/docs/apps/get) — `GET /v1/apps/*`
- [Обновить приложение](/docs/apps/update) — `PATCH /v1/apps/*`
- [Удалить приложение](/docs/apps/delete) — `DELETE /v1/apps/*`
- [Перепривязать приложение](/docs/apps/relink-oauth) — `POST /v1/apps/*/relink-oauth`
- [Опубликовать приложение](/docs/apps/publish) — `POST /v1/apps/*/publish`
- [Снять с публикации](/docs/apps/unpublish) — `POST /v1/apps/*/unpublish`

## Серверы и деплой

### [Инфраструктура](/docs/infra) · `vibe:infra`

- [Провайдеры и каталоги](/docs/infra/providers) — обзор подраздела
- [Список провайдеров](/docs/infra/providers/list) — `GET /v1/infra/providers`
- [Тарифы провайдера](/docs/infra/providers/plans) — `GET /v1/infra/providers/*/plans`
- [Регионы провайдера](/docs/infra/providers/regions) — `GET /v1/infra/providers/*/regions`
- [Образы ОС провайдера](/docs/infra/providers/images) — `GET /v1/infra/providers/*/images`
- [Серверы](/docs/infra/servers) — обзор подраздела
- [Создать сервер](/docs/infra/servers/create) — `POST /v1/infra/servers`
- [Список серверов](/docs/infra/servers/list) — `GET /v1/infra/servers`
- [Получить сервер](/docs/infra/servers/get) — `GET /v1/infra/servers/*`
- [Обновить имя и описание сервера](/docs/infra/servers/update) — `PATCH /v1/infra/servers/*`
- [Удалить сервер](/docs/infra/servers/delete) — `DELETE /v1/infra/servers/*`
- [Доступ и режимы](/docs/infra/access) — обзор подраздела
- [SSH-данные](/docs/infra/access/ssh) — `GET /v1/infra/servers/*/ssh`
- [Жизненный цикл](/docs/infra/lifecycle) — обзор подраздела
- [Остановить сервер](/docs/infra/lifecycle/stop) — `POST /v1/infra/servers/*/stop`
- [Запустить сервер](/docs/infra/lifecycle/start) — `POST /v1/infra/servers/*/start`
- [Политика доступа](/docs/infra/access/access-policy) — `PATCH /v1/infra/servers/*/access-policy`
- [Перезагрузить сервер](/docs/infra/lifecycle/reboot) — `POST /v1/infra/servers/*/reboot`
- [Усыпить сейчас](/docs/infra/lifecycle/sleep-now) — `POST /v1/infra/servers/*/sleep-now`
- [Настроить авто-сон](/docs/infra/lifecycle/sleep) — `PATCH /v1/infra/servers/*/sleep`
- [Сменить режим работы сервера](/docs/infra/lifecycle/run-mode) — `PATCH /v1/infra/servers/*/run-mode`
- [Библиотека расписаний работы](/docs/infra/work-schedules) — обзор подраздела
- [Список расписаний](/docs/infra/work-schedules/list) — `GET /v1/work-schedules`
- [Создать расписание](/docs/infra/work-schedules/create) — `POST /v1/work-schedules`
- [Получить расписание](/docs/infra/work-schedules/get) — `GET /v1/work-schedules/*`
- [Обновить расписание](/docs/infra/work-schedules/update) — `PATCH /v1/work-schedules/*`
- [Удалить расписание](/docs/infra/work-schedules/delete) — `DELETE /v1/work-schedules/*`
- [Обновить статус](/docs/infra/lifecycle/refresh) — `POST /v1/infra/servers/*/refresh`
- [Переключить режим](/docs/infra/access/mode) — `PATCH /v1/infra/servers/*/mode`
- [Deploy API](/docs/infra/deploy) — обзор подраздела
- [Задать порт приложения](/docs/infra/deploy/port) — `PATCH /v1/infra/servers/*/port`
- [Список доступа](/docs/infra/access/access-list) — `GET /v1/infra/servers/*/access`
- [Добавить пользователя или отдел](/docs/infra/access/access-add) — `POST /v1/infra/servers/*/access`
- [Удалить запись доступа](/docs/infra/access/access-delete) — `DELETE /v1/infra/servers/*/access/*`
- [Метрики туннеля](/docs/infra/deploy/metrics) — `GET /v1/infra/servers/*/metrics`
- [Поиск пользователей Битрикс24](/docs/infra/access/b24-users) — `GET /v1/infra/servers/*/b24-users`
- [Восстановить туннель](/docs/infra/lifecycle/repair) — `POST /v1/infra/servers/*/repair`
- [Выполнить команду](/docs/infra/deploy/exec) — `POST /v1/infra/servers/*/exec`
- [Загрузить файл](/docs/infra/deploy/upload) — `POST /v1/infra/servers/*/upload`
- [Логи сервиса](/docs/infra/deploy/logs) — `GET /v1/infra/servers/*/logs`
- [Полный деплой приложения](/docs/infra/deploy/deploy) — `POST /v1/infra/servers/*/deploy`
- [Снять зависший лок](/docs/infra/deploy/lock) — `DELETE /v1/infra/servers/*/lock`
- [Список рантаймов](/docs/infra/deploy/runtimes) — `GET /v1/infra/runtimes`
- [Разбудить сервер](/docs/infra/lifecycle/wake) — `POST /v1/infra/servers/*/wake`
- [Опубликовать приложение в каталоге Битрикс24](/docs/infra/servers/b24-catalog-publish) — `POST /v1/infra/servers/*/b24-catalog/publish`
- [Статус восстановления](/docs/infra/lifecycle/repair-status) — `GET /v1/infra/servers/*/repair-status`
- [Исход операции](/docs/infra/deploy/operation-status) — `GET /v1/infra/operations/*`
- [Последние операции сервера](/docs/infra/deploy/operations) — `GET /v1/infra/servers/*/operations`
- [Токены доступа](/docs/infra/access-tokens) — обзор подраздела
- [Выпустить токен доступа](/docs/infra/access-tokens/create) — `POST /v1/infra/servers/*/access-tokens`
- [Список токенов сервера](/docs/infra/access-tokens/list) — `GET /v1/infra/servers/*/access-tokens`
- [Отозвать токен](/docs/infra/access-tokens/delete) — `DELETE /v1/infra/servers/*/access-tokens/*`
- [Обновить токен доступа](/docs/infra/access-tokens/refresh) — `POST /v1/infra/servers/*/access-tokens/*/refresh`
- [Подписки на события портала](/docs/infra/event-subscriptions) — обзор подраздела
- [Создать подписку](/docs/infra/event-subscriptions/create) — `POST /v1/infra/servers/*/event-subscriptions`
- [Список подписок](/docs/infra/event-subscriptions/list) — `GET /v1/infra/servers/*/event-subscriptions`
- [Удалить подписку](/docs/infra/event-subscriptions/delete) — `DELETE /v1/infra/servers/*/event-subscriptions/*`
- [Пробуждение по расписанию](/docs/infra/wake-schedules) — обзор подраздела
- [Список окон пробуждения](/docs/infra/wake-schedules/list) — `GET /v1/infra/servers/*/wake-schedules`
- [Создать окно пробуждения](/docs/infra/wake-schedules/create) — `POST /v1/infra/servers/*/wake-schedules`
- [Обновить окно пробуждения](/docs/infra/wake-schedules/update) — `PATCH /v1/infra/servers/*/wake-schedules/*`
- [Удалить окно пробуждения](/docs/infra/wake-schedules/delete) — `DELETE /v1/infra/servers/*/wake-schedules/*`
- [Иконка приложения](/docs/infra/app-icon) — `POST /v1/infra/servers/*/icon`
- [Принудительно освободить канал](/docs/infra/servers/unstick) — `POST /v1/infra/servers/*/unstick`

### [Хранилище исходного кода](/docs/source-storage) · `vibe:infra`

- [Список версий и скачивание](/docs/source-storage/versions) — `GET /v1/apps/*/sources` `GET /v1/apps/*/sources/*` `GET /v1/apps/*/sources/*/download`
- [Сохранить снапшот](/docs/source-storage/save) — `POST /v1/apps/*/sources`
- [Теги и комментарии версии](/docs/source-storage/metadata) — `PATCH /v1/apps/*/sources/*` `POST /v1/apps/*/sources/*/tag`
- [Удаление версий](/docs/source-storage/delete) — `DELETE /v1/apps/*/sources/*` `POST /v1/apps/*/sources/cleanup`
- [Хранилище исходного кода](/docs/source-storage) — 8 операций
- [Реестр исходников и состояние портала](/docs/source-storage/registry) — `GET /v1/me/sources`

### [Хранилище](/docs/storage)

- [Загрузка](/docs/storage/upload) — обзор подраздела
- [Создать предподписанный URL](/docs/storage/upload/presigned) — `POST /v1/storage/objects`
- [Объекты](/docs/storage/objects) — обзор подраздела
- [Список объектов](/docs/storage/objects/list) — `GET /v1/storage/objects`
- [Подтвердить загрузку](/docs/storage/upload/complete) — `POST /v1/storage/objects/complete`
- [Прямая загрузка файла](/docs/storage/upload/direct) — `POST /v1/storage/objects/upload`
- [Создать составную загрузку](/docs/storage/upload/multipart-create) — `POST /v1/storage/objects/multipart/create`
- [Завершить составную загрузку](/docs/storage/upload/multipart-complete) — `POST /v1/storage/objects/multipart/complete`
- [Отменить составную загрузку](/docs/storage/upload/multipart-abort) — `POST /v1/storage/objects/multipart/abort`
- [Скачать объект](/docs/storage/objects/get) — `GET /v1/storage/objects/*`
- [Метаданные объекта](/docs/storage/objects/head) — `HEAD /v1/storage/objects/*`
- [Удалить объект](/docs/storage/objects/delete) — `DELETE /v1/storage/objects/*`
- [Публичный доступ к объекту](/docs/storage/objects/public-get) — `GET /v1/public-storage/*/*`
- [Публичные метаданные объекта](/docs/storage/objects/public-head) — `HEAD /v1/public-storage/*/*`

## AI

### [AI-агенты](/docs/agents)

- [Список AI-агентов](/docs/agents/list) — `GET /v1/agents`

### [AI Router](/docs/ai)

- [Модели](/docs/ai/models) — обзор подраздела
- [Список моделей](/docs/ai/models/list) — `GET /v1/models` `GET /v1/ai/models`
- [Чат-комплишены](/docs/ai/chat) — обзор подраздела
- [Создать чат-комплишен](/docs/ai/chat/completions) — `POST /v1/chat/completions` `POST /v1/ai/chat/completions`
- [Распознавание речи](/docs/ai/audio) — обзор подраздела
- [Расшифровать аудио](/docs/ai/audio/transcriptions) — `POST /v1/audio/transcriptions` `POST /v1/ai/audio/transcriptions`
- [Сгенерировать изображение](/docs/ai/images) — `POST /v1/images/generations` `POST /v1/ai/images/generations`
- [Создать эмбеддинги](/docs/ai/embeddings) — `POST /v1/embeddings` `POST /v1/ai/embeddings`
- [Расход и лимиты](/docs/ai/consumption) — обзор подраздела
- [Статистика использования](/docs/ai/consumption/usage) — `GET /v1/ai/usage`
- [AI-квота компании](/docs/ai/consumption/quota) — `GET /v1/ai/quota`
- [Расписание выгодных часов](/docs/ai/consumption/off-peak) — `GET /v1/off-peak`

### [Коворк/Код](/docs/cowork) · `vibe:cowork`

- [Состояние подписки Cowork/Code](/docs/cowork/state) — `GET /v1/cowork/state`
- [Сводка по подписке Cowork/Code](/docs/cowork/me) — `GET /v1/cowork/me`
- [Включить пробный период Маркета](/docs/cowork/activate-market-trial) — `POST /v1/cowork/activate-market-trial`
- [Предрасчёт смены тарифа Cowork/Code](/docs/cowork/subscription-preview) — `GET /v1/cowork/subscription/preview`
- [Проектный ключ для деплоя](/docs/cowork/deploy-key) — `POST /v1/cowork/deploy-key`
- [Параметры создания приложения](/docs/cowork/applications-defaults) — `GET /v1/cowork/applications/defaults`
- [Создать приложение из Cowork/Code](/docs/cowork/applications-create) — `POST /v1/cowork/applications`
- [Отключить это устройство](/docs/cowork/key) — `DELETE /v1/cowork/key`
- [Проверить купон](/docs/cowork/coupon-preview) — `POST /v1/cowork/coupon/preview`
- [Погасить купон](/docs/cowork/coupon-redeem) — `POST /v1/cowork/coupon/redeem`

### [Web Search для AI](/docs/search)

- [Поиск](/docs/search/run) — `POST /v1/search`
- [Глубокий поиск (research)](/docs/search/research) — `POST /v1/research`
- [Список провайдеров](/docs/search/providers) — `GET /v1/search/providers`
- [Свои ключи (BYOK)](/docs/search/credentials) — обзор подраздела
- [Список своих ключей](/docs/search/credentials/list) — `GET /v1/search/credentials`
- [Добавить ключ](/docs/search/credentials/create) — `POST /v1/search/credentials`
- [Удалить ключ](/docs/search/credentials/delete) — `DELETE /v1/search/credentials/*`
- [Проверить ключ](/docs/search/credentials/test) — `POST /v1/search/credentials/*/test`

## CRM

### [Автоматизация](/docs/automation) · `bizproc` `crm`

- [Бизнес-процессы](/docs/automation/workflows) — обзор подраздела
- [Список запущенных бизнес-процессов](/docs/automation/workflows/list) — `GET /v1/workflows`
- [Запустить бизнес-процесс](/docs/automation/workflows/start) — `POST /v1/workflows/start`
- [Завершить бизнес-процесс](/docs/automation/workflows/terminate) — `DELETE /v1/workflows/*`
- [Отправить событие в процесс](/docs/automation/workflows/event) — `POST /v1/workflows/event`
- [Триггеры](/docs/automation/triggers) — обзор подраздела
- [Список триггеров автоматизации](/docs/automation/triggers/list) — `GET /v1/triggers`
- [Активировать триггер](/docs/automation/triggers/fire) — `POST /v1/triggers/fire`

### [Поиск дубликатов](/docs/duplicates) · `crm`

- [Поиск дубликатов](/docs/duplicates) — `POST /v1/duplicates/find`

### [Дела](/docs/entities/activities) · `crm`

- [Список дел](/docs/entities/activities/list) — `GET /v1/activities`
- [Создать дело](/docs/entities/activities/create) — `POST /v1/activities`
- [Получить дело](/docs/entities/activities/get) — `GET /v1/activities/*`
- [Обновить дело](/docs/entities/activities/update) — `PATCH /v1/activities/*`
- [Удалить дело](/docs/entities/activities/delete) — `DELETE /v1/activities/*`
- [Поиск дел](/docs/entities/activities/search) — `POST /v1/activities/search`
- [Агрегация дел](/docs/entities/activities/aggregate) — `POST /v1/activities/aggregate`
- [Поля дела](/docs/entities/activities/fields) — `GET /v1/activities/fields`
- [Расшифровки звонков CRM](/docs/entities/activities/transcript) — `GET /v1/activities/*/transcript`
- [Скачать файл дела](/docs/entities/activities/file-download) — `GET /v1/activities/*/files/*/download`
- [Конфигурируемые дела](/docs/entities/activities/configurable) — обзор подраздела
- [Создать дело](/docs/entities/activities/configurable/create) — `POST /v1/activity-configurable`
- [Получить дело](/docs/entities/activities/configurable/get) — `GET /v1/activity-configurable/*`
- [Обновить дело](/docs/entities/activities/configurable/update) — `PATCH /v1/activity-configurable/*`

### [Адреса](/docs/entities/addresses) · `crm`

- [Поля адреса](/docs/entities/addresses/fields) — `GET /v1/addresses/fields`

### [Банковские реквизиты](/docs/entities/bank-details) · `crm`

- [Список банковских реквизитов](/docs/entities/bank-details/list) — `GET /v1/bank-details`
- [Создать банковский реквизит](/docs/entities/bank-details/create) — `POST /v1/bank-details`
- [Получить банковский реквизит](/docs/entities/bank-details/get) — `GET /v1/bank-details/*`
- [Обновить банковский реквизит](/docs/entities/bank-details/update) — `PATCH /v1/bank-details/*`
- [Удалить банковский реквизит](/docs/entities/bank-details/delete) — `DELETE /v1/bank-details/*`
- [Поиск банковских реквизитов](/docs/entities/bank-details/search) — `POST /v1/bank-details/search`
- [Поля банковского реквизита](/docs/entities/bank-details/fields) — `GET /v1/bank-details/fields`

### [Воронки](/docs/entities/categories) · `crm`

- [Список воронок](/docs/entities/categories/list) — `GET /v1/categories/*`
- [Создать воронку](/docs/entities/categories/create) — `POST /v1/categories/*`
- [Получить воронку](/docs/entities/categories/get) — `GET /v1/categories/*/*`
- [Обновить воронку](/docs/entities/categories/update) — `PATCH /v1/categories/*/*`
- [Удалить воронку](/docs/entities/categories/delete) — `DELETE /v1/categories/*/*`
- [Поиск воронок](/docs/entities/categories/search) — `POST /v1/categories/*/search`
- [Поля воронки](/docs/entities/categories/fields) — `GET /v1/categories/*/fields`

### [Компании](/docs/entities/companies) · `crm`

- [Список компаний](/docs/entities/companies/list) — `GET /v1/companies`
- [Создать компанию](/docs/entities/companies/create) — `POST /v1/companies`
- [Получить компанию](/docs/entities/companies/get) — `GET /v1/companies/*`
- [Обновить компанию](/docs/entities/companies/update) — `PATCH /v1/companies/*`
- [Удалить компанию](/docs/entities/companies/delete) — `DELETE /v1/companies/*`
- [Поиск компаний](/docs/entities/companies/search) — `POST /v1/companies/search`
- [Агрегация компаний](/docs/entities/companies/aggregate) — `POST /v1/companies/aggregate`
- [Поля компании](/docs/entities/companies/fields) — `GET /v1/companies/fields`
- [Контакты компании](/docs/entities/companies/contacts) — `GET /v1/companies/*/contacts` `POST /v1/companies/*/contacts` `PUT /v1/companies/*/contacts` `DELETE /v1/companies/*/contacts/*`

### [Контакты](/docs/entities/contacts) · `crm`

- [Список контактов](/docs/entities/contacts/list) — `GET /v1/contacts`
- [Создать контакт](/docs/entities/contacts/create) — `POST /v1/contacts`
- [Получить контакт](/docs/entities/contacts/get) — `GET /v1/contacts/*`
- [Обновить контакт](/docs/entities/contacts/update) — `PATCH /v1/contacts/*`
- [Удалить контакт](/docs/entities/contacts/delete) — `DELETE /v1/contacts/*`
- [Поиск контактов](/docs/entities/contacts/search) — `POST /v1/contacts/search`
- [Агрегация контактов](/docs/entities/contacts/aggregate) — `POST /v1/contacts/aggregate`
- [Поля контакта](/docs/entities/contacts/fields) — `GET /v1/contacts/fields`

### [Раскладка карточки CRM](/docs/entities/crm-card-config) · `crm`

- [Получить раскладку карточки](/docs/entities/crm-card-config/get) — `GET /v1/crm/card-config/*`
- [Установить раскладку карточки](/docs/entities/crm-card-config/set) — `PUT /v1/crm/card-config/*`
- [Сбросить раскладку карточки](/docs/entities/crm-card-config/reset) — `DELETE /v1/crm/card-config/*`
- [Общая раскладка для всех сотрудников](/docs/entities/crm-card-config/force-common) — `POST /v1/crm/card-config/*/force-common`

### [Валюты](/docs/entities/currencies) · `crm`

- [Список валют](/docs/entities/currencies/list) — `GET /v1/currencies`
- [Создать валюту](/docs/entities/currencies/create) — `POST /v1/currencies`
- [Получить валюту](/docs/entities/currencies/get) — `GET /v1/currencies/*`
- [Обновить валюту](/docs/entities/currencies/update) — `PATCH /v1/currencies/*`
- [Удалить валюту](/docs/entities/currencies/delete) — `DELETE /v1/currencies/*`
- [Поиск валют](/docs/entities/currencies/search) — `POST /v1/currencies/search`
- [Агрегация валют](/docs/entities/currencies/aggregate) — `POST /v1/currencies/aggregate`
- [Поля валюты](/docs/entities/currencies/fields) — `GET /v1/currencies/fields`

### [Воронки сделок](/docs/entities/deal-categories) · `crm`

- [Список воронок](/docs/entities/deal-categories/list) — `GET /v1/deal-categories`
- [Создать воронку](/docs/entities/deal-categories/create) — `POST /v1/deal-categories`
- [Получить воронку](/docs/entities/deal-categories/get) — `GET /v1/deal-categories/*`
- [Обновить воронку](/docs/entities/deal-categories/update) — `PATCH /v1/deal-categories/*`
- [Удалить воронку](/docs/entities/deal-categories/delete) — `DELETE /v1/deal-categories/*`
- [Поиск воронок](/docs/entities/deal-categories/search) — `POST /v1/deal-categories/search`
- [Агрегация воронок](/docs/entities/deal-categories/aggregate) — `POST /v1/deal-categories/aggregate`
- [Поля воронки](/docs/entities/deal-categories/fields) — `GET /v1/deal-categories/fields`

### [Сделки](/docs/entities/deals) · `crm`

- [Список сделок](/docs/entities/deals/list) — `GET /v1/deals`
- [Создать сделку](/docs/entities/deals/create) — `POST /v1/deals`
- [Получить сделку](/docs/entities/deals/get) — `GET /v1/deals/*`
- [Обновить сделку](/docs/entities/deals/update) — `PATCH /v1/deals/*`
- [Удалить сделку](/docs/entities/deals/delete) — `DELETE /v1/deals/*`
- [Поиск сделок](/docs/entities/deals/search) — `POST /v1/deals/search`
- [Агрегация сделок](/docs/entities/deals/aggregate) — `POST /v1/deals/aggregate`
- [Поля сделки](/docs/entities/deals/fields) — `GET /v1/deals/fields`
- [Контакты сделки](/docs/entities/deals/contacts) — `GET /v1/deals/*/contacts` `POST /v1/deals/*/contacts` `PUT /v1/deals/*/contacts` `DELETE /v1/deals/*/contacts/*`
- [Товарные позиции сделки](/docs/entities/deals/products-get) — `GET /v1/deals/*/products`
- [Установить товары сделки](/docs/entities/deals/products-set) — `PUT /v1/deals/*/products`
- [Добавить товар в сделку](/docs/entities/deals/products-add) — `POST /v1/deals/*/products`
- [Поля товаров сделки](/docs/entities/deals/products-fields) — `GET /v1/deals/*/products/fields`
- [Получить товар из сделки](/docs/entities/deals/products-get-single) — `GET /v1/deals/*/products/*`
- [Обновить товар сделки](/docs/entities/deals/products-update) — `PATCH /v1/deals/*/products/*`
- [Удалить товар из сделки](/docs/entities/deals/products-delete) — `DELETE /v1/deals/*/products/*`
- [Перевести сделку на другую стадию](/docs/entities/deals/move) — `POST /v1/deals/*/move`

### [Счета](/docs/entities/invoices) · `crm`

- [Список счетов](/docs/entities/invoices/list) — `GET /v1/invoices`
- [Создать счёт](/docs/entities/invoices/create) — `POST /v1/invoices`
- [Получить счёт](/docs/entities/invoices/get) — `GET /v1/invoices/*`
- [Обновить счёт](/docs/entities/invoices/update) — `PATCH /v1/invoices/*`
- [Удалить счёт](/docs/entities/invoices/delete) — `DELETE /v1/invoices/*`
- [Поиск счетов](/docs/entities/invoices/search) — `POST /v1/invoices/search`
- [Агрегация счетов](/docs/entities/invoices/aggregate) — `POST /v1/invoices/aggregate`
- [Поля счёта](/docs/entities/invoices/fields) — `GET /v1/invoices/fields`
- [Товарные позиции счёта](/docs/entities/invoices/products-get) — `GET /v1/invoices/*/products`
- [Установить товары счёта](/docs/entities/invoices/products-set) — `PUT /v1/invoices/*/products`
- [Добавить товар в счёт](/docs/entities/invoices/products-add) — `POST /v1/invoices/*/products`
- [Поля товаров счёта](/docs/entities/invoices/products-fields) — `GET /v1/invoices/*/products/fields`
- [Получить товар из счёта](/docs/entities/invoices/products-get-single) — `GET /v1/invoices/*/products/*`
- [Обновить товар счёта](/docs/entities/invoices/products-update) — `PATCH /v1/invoices/*/products/*`
- [Удалить товар из счёта](/docs/entities/invoices/products-delete) — `DELETE /v1/invoices/*/products/*`

### [Смарт-процессы (Items)](/docs/entities/items) · `crm`

- [Список элементов смарт-процесса](/docs/entities/items/list) — `GET /v1/items/*`
- [Создать элемент смарт-процесса](/docs/entities/items/create) — `POST /v1/items/*`
- [Получить элемент смарт-процесса](/docs/entities/items/get) — `GET /v1/items/*/*`
- [Обновить элемент смарт-процесса](/docs/entities/items/update) — `PATCH /v1/items/*/*`
- [Удалить элемент](/docs/entities/items/delete) — `DELETE /v1/items/*/*`
- [Поиск элементов смарт-процесса](/docs/entities/items/search) — `POST /v1/items/*/search`
- [Агрегация элементов](/docs/entities/items/aggregate) — `POST /v1/items/*/aggregate`
- [Поля элемента смарт-процесса](/docs/entities/items/fields) — `GET /v1/items/*/fields`
- [Товарные позиции элемента](/docs/entities/items/products-get) — `GET /v1/items/*/*/products`
- [Установить товары элемента смарт-процесса](/docs/entities/items/products-set) — `PUT /v1/items/*/*/products`
- [Добавить товар в элемент смарт-процесса](/docs/entities/items/products-add) — `POST /v1/items/*/*/products`
- [Поля товаров элемента](/docs/entities/items/products-fields) — `GET /v1/items/*/*/products/fields`
- [Получить товар из элемента](/docs/entities/items/products-get-single) — `GET /v1/items/*/*/products/*`
- [Обновить товар элемента](/docs/entities/items/products-update) — `PATCH /v1/items/*/*/products/*`
- [Удалить товар из элемента смарт-процесса](/docs/entities/items/products-delete) — `DELETE /v1/items/*/*/products/*`

### [Лиды](/docs/entities/leads) · `crm`

- [Список лидов](/docs/entities/leads/list) — `GET /v1/leads`
- [Создать лид](/docs/entities/leads/create) — `POST /v1/leads`
- [Получить лид](/docs/entities/leads/get) — `GET /v1/leads/*`
- [Обновить лид](/docs/entities/leads/update) — `PATCH /v1/leads/*`
- [Удалить лид](/docs/entities/leads/delete) — `DELETE /v1/leads/*`
- [Поиск лидов](/docs/entities/leads/search) — `POST /v1/leads/search`
- [Агрегация лидов](/docs/entities/leads/aggregate) — `POST /v1/leads/aggregate`
- [Поля лида](/docs/entities/leads/fields) — `GET /v1/leads/fields`
- [Товарные позиции лида](/docs/entities/leads/products-get) — `GET /v1/leads/*/products`
- [Установить товары лида](/docs/entities/leads/products-set) — `PUT /v1/leads/*/products`
- [Добавить товар в лид](/docs/entities/leads/products-add) — `POST /v1/leads/*/products`
- [Поля товаров лида](/docs/entities/leads/products-fields) — `GET /v1/leads/*/products/fields`
- [Получить товар из лида](/docs/entities/leads/products-get-single) — `GET /v1/leads/*/products/*`
- [Обновить товар лида](/docs/entities/leads/products-update) — `PATCH /v1/leads/*/products/*`
- [Удалить товар из лида](/docs/entities/leads/products-delete) — `DELETE /v1/leads/*/products/*`
- [Перевести лид на другой статус](/docs/entities/leads/move) — `POST /v1/leads/*/move`
- [Конвертировать лид](/docs/entities/leads/convert) — `POST /v1/leads/*/convert`

### [Разделы товаров](/docs/entities/product-sections) · `crm`

- [Список разделов](/docs/entities/product-sections/list) — `GET /v1/product-sections`
- [Создать раздел](/docs/entities/product-sections/create) — `POST /v1/product-sections`
- [Получить раздел](/docs/entities/product-sections/get) — `GET /v1/product-sections/*`
- [Обновить раздел](/docs/entities/product-sections/update) — `PATCH /v1/product-sections/*`
- [Удалить раздел](/docs/entities/product-sections/delete) — `DELETE /v1/product-sections/*`
- [Поиск разделов](/docs/entities/product-sections/search) — `POST /v1/product-sections/search`
- [Поля раздела](/docs/entities/product-sections/fields) — `GET /v1/product-sections/fields`

### [Товары](/docs/entities/products) · `crm`

- [Список товаров CRM](/docs/entities/products/list) — `GET /v1/products`
- [Создать товар CRM](/docs/entities/products/create) — `POST /v1/products`
- [Получить товар CRM](/docs/entities/products/get) — `GET /v1/products/*`
- [Обновить товар CRM](/docs/entities/products/update) — `PATCH /v1/products/*`
- [Удалить товар CRM](/docs/entities/products/delete) — `DELETE /v1/products/*`
- [Поиск товаров CRM](/docs/entities/products/search) — `POST /v1/products/search`
- [Агрегация товаров CRM](/docs/entities/products/aggregate) — `POST /v1/products/aggregate`
- [Поля товара CRM](/docs/entities/products/fields) — `GET /v1/products/fields`

### [Предложения](/docs/entities/quotes) · `crm`

- [Список предложений](/docs/entities/quotes/list) — `GET /v1/quotes`
- [Создать предложение](/docs/entities/quotes/create) — `POST /v1/quotes`
- [Получить предложение](/docs/entities/quotes/get) — `GET /v1/quotes/*`
- [Обновить предложение](/docs/entities/quotes/update) — `PATCH /v1/quotes/*`
- [Удалить предложение](/docs/entities/quotes/delete) — `DELETE /v1/quotes/*`
- [Поиск предложений](/docs/entities/quotes/search) — `POST /v1/quotes/search`
- [Агрегация предложений](/docs/entities/quotes/aggregate) — `POST /v1/quotes/aggregate`
- [Поля предложения](/docs/entities/quotes/fields) — `GET /v1/quotes/fields`
- [Товарные позиции предложения](/docs/entities/quotes/products-get) — `GET /v1/quotes/*/products`
- [Установить товары предложения](/docs/entities/quotes/products-set) — `PUT /v1/quotes/*/products`
- [Добавить товар в предложение](/docs/entities/quotes/products-add) — `POST /v1/quotes/*/products`
- [Поля товаров предложения](/docs/entities/quotes/products-fields) — `GET /v1/quotes/*/products/fields`
- [Получить товар из предложения](/docs/entities/quotes/products-get-single) — `GET /v1/quotes/*/products/*`
- [Обновить товар предложения](/docs/entities/quotes/products-update) — `PATCH /v1/quotes/*/products/*`
- [Удалить товар из предложения](/docs/entities/quotes/products-delete) — `DELETE /v1/quotes/*/products/*`

### [Связи реквизитов](/docs/entities/requisite-links) · `crm`

- [Список связей реквизитов](/docs/entities/requisite-links/list) — `GET /v1/requisite-links`
- [Зарегистрировать связь реквизита](/docs/entities/requisite-links/register) — `POST /v1/requisite-links`
- [Поля связи реквизита](/docs/entities/requisite-links/fields) — `GET /v1/requisite-links/fields`
- [Поиск связей реквизитов](/docs/entities/requisite-links/search) — `POST /v1/requisite-links/search`
- [Получить связь реквизитов](/docs/entities/requisite-links/get) — `GET /v1/requisite-links/*/*`
- [Обновить связь реквизита](/docs/entities/requisite-links/update) — `PATCH /v1/requisite-links/*/*`
- [Удалить связь реквизита](/docs/entities/requisite-links/unregister) — `DELETE /v1/requisite-links/*/*`

### [Шаблоны реквизитов](/docs/entities/requisite-presets) · `crm`

- [Список шаблонов реквизитов](/docs/entities/requisite-presets/list) — `GET /v1/requisite-presets`
- [Создать шаблон реквизитов](/docs/entities/requisite-presets/create) — `POST /v1/requisite-presets`
- [Получить шаблон реквизитов](/docs/entities/requisite-presets/get) — `GET /v1/requisite-presets/*`
- [Обновить шаблон реквизитов](/docs/entities/requisite-presets/update) — `PATCH /v1/requisite-presets/*`
- [Удалить шаблон реквизитов](/docs/entities/requisite-presets/delete) — `DELETE /v1/requisite-presets/*`
- [Поиск шаблонов реквизитов](/docs/entities/requisite-presets/search) — `POST /v1/requisite-presets/search`
- [Поля шаблонов реквизитов](/docs/entities/requisite-presets/fields) — `GET /v1/requisite-presets/fields`

### [Реквизиты](/docs/entities/requisites) · `crm`

- [Список реквизитов](/docs/entities/requisites/list) — `GET /v1/requisites`
- [Создать реквизит](/docs/entities/requisites/create) — `POST /v1/requisites`
- [Получить реквизит](/docs/entities/requisites/get) — `GET /v1/requisites/*`
- [Обновить реквизит](/docs/entities/requisites/update) — `PATCH /v1/requisites/*`
- [Удалить реквизит](/docs/entities/requisites/delete) — `DELETE /v1/requisites/*`
- [Поиск реквизитов](/docs/entities/requisites/search) — `POST /v1/requisites/search`
- [Агрегация реквизитов](/docs/entities/requisites/aggregate) — `POST /v1/requisites/aggregate`
- [Поля реквизита](/docs/entities/requisites/fields) — `GET /v1/requisites/fields`

### [Типы смарт-процессов](/docs/entities/smart-processes) · `crm`

- [Список типов смарт-процессов](/docs/entities/smart-processes/list) — `GET /v1/smart-processes`
- [Создать тип смарт-процесса](/docs/entities/smart-processes/create) — `POST /v1/smart-processes`
- [Получить тип смарт-процесса](/docs/entities/smart-processes/get) — `GET /v1/smart-processes/*`
- [Обновить тип смарт-процесса](/docs/entities/smart-processes/update) — `PATCH /v1/smart-processes/*`
- [Удалить тип смарт-процесса](/docs/entities/smart-processes/delete) — `DELETE /v1/smart-processes/*`
- [Поиск типов смарт-процессов](/docs/entities/smart-processes/search) — `POST /v1/smart-processes/search`
- [Агрегация типов смарт-процессов](/docs/entities/smart-processes/aggregate) — `POST /v1/smart-processes/aggregate`
- [Поля типа смарт-процесса](/docs/entities/smart-processes/fields) — `GET /v1/smart-processes/fields`

### [Справочники CRM](/docs/entities/statuses) · `crm`

- [Список справочников](/docs/entities/statuses/list) — `GET /v1/statuses`
- [Создать запись справочника](/docs/entities/statuses/create) — `POST /v1/statuses`
- [Получить запись справочника](/docs/entities/statuses/get) — `GET /v1/statuses/*`
- [Обновить запись справочника](/docs/entities/statuses/update) — `PATCH /v1/statuses/*`
- [Удалить запись справочника](/docs/entities/statuses/delete) — `DELETE /v1/statuses/*`
- [Поиск записей справочника](/docs/entities/statuses/search) — `POST /v1/statuses/search`
- [Агрегация записей справочника](/docs/entities/statuses/aggregate) — `POST /v1/statuses/aggregate`
- [Поля справочника](/docs/entities/statuses/fields) — `GET /v1/statuses/fields`

### [Комментарии таймлайна](/docs/entities/timelines) · `crm`

- [Список комментариев](/docs/entities/timelines/list) — `GET /v1/timelines`
- [Добавить комментарий](/docs/entities/timelines/create) — `POST /v1/timelines`
- [Получить комментарий](/docs/entities/timelines/get) — `GET /v1/timelines/*`
- [Обновить комментарий](/docs/entities/timelines/update) — `PATCH /v1/timelines/*`
- [Удалить комментарий](/docs/entities/timelines/delete) — `DELETE /v1/timelines/*`
- [Поиск комментариев](/docs/entities/timelines/search) — `POST /v1/timelines/search`
- [Поля комментария](/docs/entities/timelines/fields) — `GET /v1/timelines/fields`
- [Скачать вложение комментария таймлайна](/docs/entities/timelines/file-download) — `GET /v1/timelines/*/files/*/download`
- [Комментарии таймлайна](/docs/entities/timelines) — 8 операций

### [Импорт в CRM](/docs/import) · `crm`

- [Импорт записей CRM](/docs/import) — 7 операций

### [История стадий](/docs/stage-history) · `crm`

- [История стадий](/docs/stage-history) — `GET /v1/stage-history`

### [Таймлайн CRM](/docs/timeline-logs) · `crm`

- [Записи журнала](/docs/timeline-logs/logs) — обзор подраздела
- [Создать запись](/docs/timeline-logs/logs/create) — `POST /v1/timeline-logs`
- [Список записей](/docs/timeline-logs/logs/list) — `GET /v1/timeline-logs`
- [Получить запись](/docs/timeline-logs/logs/get) — `GET /v1/timeline-logs/*`
- [Удалить запись](/docs/timeline-logs/logs/delete) — `DELETE /v1/timeline-logs/*`
- [Заметки](/docs/timeline-logs/notes) — обзор подраздела
- [Сохранить заметку](/docs/timeline-logs/notes/save) — `POST /v1/timeline-logs/*/note`
- [Получить заметку](/docs/timeline-logs/notes/get) — `GET /v1/timeline-logs/*/note`
- [Удалить заметку](/docs/timeline-logs/notes/delete) — `DELETE /v1/timeline-logs/*/note`
- [Закрепления](/docs/timeline-logs/pins) — обзор подраздела
- [Закрепить запись](/docs/timeline-logs/pins/pin) — `POST /v1/timeline-logs/*/pin`
- [Открепить запись](/docs/timeline-logs/pins/unpin) — `POST /v1/timeline-logs/*/unpin`
- [Привязки](/docs/timeline-logs/bindings) — обзор подраздела
- [Привязать запись](/docs/timeline-logs/bindings/bind) — `POST /v1/timeline-logs/*/bind`
- [Отвязать](/docs/timeline-logs/bindings/unbind) — `POST /v1/timeline-logs/*/unbind`
- [Список привязок](/docs/timeline-logs/bindings/list) — `GET /v1/timeline-logs/*/bindings`

### [Пользовательские поля](/docs/userfields) · `crm` `user.userfield`

- [Поля CRM-сущностей](/docs/userfields/crm) — обзор подраздела
- [Список полей сущности](/docs/userfields/crm/list) — `GET /v1/userfields/*`
- [Создать поле](/docs/userfields/crm/create) — `POST /v1/userfields/*`
- [Каталог типов полей](/docs/userfields/crm/types) — `GET /v1/userfields/*/types`
- [Получить поле](/docs/userfields/crm/get) — `GET /v1/userfields/*/*`
- [Обновить поле](/docs/userfields/crm/update) — `PATCH /v1/userfields/*/*`
- [Удалить поле](/docs/userfields/crm/delete) — `DELETE /v1/userfields/*/*`
- [Поля смарт-процессов](/docs/userfields/smart-processes) — обзор подраздела
- [Список полей смарт-процесса](/docs/userfields/smart-processes/list) — `GET /v1/items/*/userfields`
- [Создать поле](/docs/userfields/smart-processes/create) — `POST /v1/items/*/userfields`
- [Каталог типов полей](/docs/userfields/smart-processes/types) — `GET /v1/items/*/userfields/types`
- [Получить поле](/docs/userfields/smart-processes/get) — `GET /v1/items/*/userfields/*`
- [Обновить поле](/docs/userfields/smart-processes/update) — `PATCH /v1/items/*/userfields/*`
- [Удалить поле](/docs/userfields/smart-processes/delete) — `DELETE /v1/items/*/userfields/*`
- [Поля сотрудников](/docs/userfields/users) — обзор подраздела
- [Список полей сотрудников](/docs/userfields/users/list) — `GET /v1/userfields/users`
- [Создать поле сотрудника](/docs/userfields/users/create) — `POST /v1/userfields/users`
- [Получить поле сотрудника](/docs/userfields/users/get) — `GET /v1/userfields/users/*`
- [Обновить поле сотрудника](/docs/userfields/users/update) — `PATCH /v1/userfields/users/*`
- [Удалить поле сотрудника](/docs/userfields/users/delete) — `DELETE /v1/userfields/users/*`

## Задачи и календарь

### [Календарь](/docs/calendar) · `calendar`

- [Настройки календаря](/docs/calendar/settings) — `GET /v1/calendar/settings`

### [Ресурсы бронирования](/docs/entities/booking-resources) · `booking`

- [Список ресурсов бронирования](/docs/entities/booking-resources) — `GET /v1/booking-resources`

### [Бронирования](/docs/entities/bookings) · `booking`

- [Создать бронирование](/docs/entities/bookings/create) — `POST /v1/bookings`
- [Список бронирований](/docs/entities/bookings/list) — `GET /v1/bookings`
- [Получить бронирование](/docs/entities/bookings/get) — `GET /v1/bookings/*`
- [Обновить бронирование](/docs/entities/bookings/update) — `PATCH /v1/bookings/*`
- [Удалить бронирование](/docs/entities/bookings/delete) — `DELETE /v1/bookings/*`
- [Поля бронирования](/docs/entities/bookings/fields) — `GET /v1/bookings/fields`
- [Поиск бронирований](/docs/entities/bookings/search) — `POST /v1/bookings/search`

### [События календаря](/docs/entities/calendar-events) · `calendar`

- [Список событий](/docs/entities/calendar-events/list) — `GET /v1/calendar-events`
- [Создать событие](/docs/entities/calendar-events/create) — `POST /v1/calendar-events`
- [Получить событие](/docs/entities/calendar-events/get) — `GET /v1/calendar-events/*`
- [Обновить событие](/docs/entities/calendar-events/update) — `PATCH /v1/calendar-events/*`
- [Удалить событие](/docs/entities/calendar-events/delete) — `DELETE /v1/calendar-events/*`
- [Поиск событий календаря](/docs/entities/calendar-events/search) — `POST /v1/calendar-events/search`
- [Поля события](/docs/entities/calendar-events/fields) — `GET /v1/calendar-events/fields`

### [Секции календаря](/docs/entities/calendar-sections) · `calendar`

- [Список секций](/docs/entities/calendar-sections/list) — `GET /v1/calendar-sections`
- [Создать секцию](/docs/entities/calendar-sections/create) — `POST /v1/calendar-sections`
- [Обновить секцию](/docs/entities/calendar-sections/update) — `PATCH /v1/calendar-sections/*`
- [Удалить секцию](/docs/entities/calendar-sections/delete) — `DELETE /v1/calendar-sections/*`
- [Поиск секций календаря](/docs/entities/calendar-sections/search) — `POST /v1/calendar-sections/search`
- [Пакет операций над секциями календаря](/docs/entities/calendar-sections/batch) — `POST /v1/calendar-sections/batch`
- [Поля секции календаря](/docs/entities/calendar-sections/fields) — `GET /v1/calendar-sections/fields`

### [Комментарии задач](/docs/entities/task-comments) · `tasks`

- [Список комментариев](/docs/entities/task-comments/list) — `GET /v1/tasks/*/comments`
- [Создать комментарий](/docs/entities/task-comments/create) — `POST /v1/tasks/*/comments`
- [Поля комментария](/docs/entities/task-comments/fields) — `GET /v1/tasks/*/comments/fields`
- [Получить комментарий](/docs/entities/task-comments/get) — `GET /v1/tasks/*/comments/*`
- [Обновить комментарий](/docs/entities/task-comments/update) — `PATCH /v1/tasks/*/comments/*`
- [Удалить комментарий](/docs/entities/task-comments/delete) — `DELETE /v1/tasks/*/comments/*`
- [Скачать вложение комментария задачи](/docs/entities/task-comments/file-download) — `GET /v1/tasks/*/comments/*/files/*/download`
- [Пакет операций над комментариями](/docs/entities/task-comments/comments-batch) — `POST /v1/tasks/*/comments/batch`

### [Задачи](/docs/entities/tasks) · `task` `tasks`

- [Список задач](/docs/entities/tasks/list) — `GET /v1/tasks`
- [Создать задачу](/docs/entities/tasks/create) — `POST /v1/tasks`
- [Получить задачу](/docs/entities/tasks/get) — `GET /v1/tasks/*`
- [Обновить задачу](/docs/entities/tasks/update) — `PATCH /v1/tasks/*`
- [Удалить задачу](/docs/entities/tasks/delete) — `DELETE /v1/tasks/*`
- [Поиск задач](/docs/entities/tasks/search) — `POST /v1/tasks/search`
- [Агрегация задач](/docs/entities/tasks/aggregate) — `POST /v1/tasks/aggregate`
- [Поля задачи](/docs/entities/tasks/fields) — `GET /v1/tasks/fields`
- [Учёт времени задач](/docs/entities/tasks/time) — обзор подраздела
- [Список записей учёта времени](/docs/entities/tasks/time/list) — `GET /v1/tasks/*/time`
- [Добавить запись учёта времени](/docs/entities/tasks/time/create) — `POST /v1/tasks/*/time`
- [Получить запись учёта времени](/docs/entities/tasks/time/get) — `GET /v1/tasks/*/time/*`
- [Обновить запись учёта времени](/docs/entities/tasks/time/update) — `PATCH /v1/tasks/*/time/*`
- [Удалить запись учёта времени](/docs/entities/tasks/time/delete) — `DELETE /v1/tasks/*/time/*`
- [Чек-лист задачи](/docs/entities/tasks/checklist) — обзор подраздела
- [Список пунктов чек-листа](/docs/entities/tasks/checklist/list) — `GET /v1/tasks/*/checklist`
- [Добавить пункт чек-листа](/docs/entities/tasks/checklist/create) — `POST /v1/tasks/*/checklist`
- [Получить пункт чек-листа](/docs/entities/tasks/checklist/get) — `GET /v1/tasks/*/checklist/*`
- [Обновить пункт чек-листа](/docs/entities/tasks/checklist/update) — `PATCH /v1/tasks/*/checklist/*`
- [Удалить пункт чек-листа](/docs/entities/tasks/checklist/delete) — `DELETE /v1/tasks/*/checklist/*`
- [Отметить пункт выполненным](/docs/entities/tasks/checklist/complete) — `POST /v1/tasks/*/checklist/*/complete`
- [Вернуть пункт в работу](/docs/entities/tasks/checklist/renew) — `POST /v1/tasks/*/checklist/*/renew`
- [Связи задач](/docs/entities/tasks/dependencies) — `GET /v1/tasks/*/dependencies` `POST /v1/tasks/dependencies/bulk`
- [Добавить задачу в избранное](/docs/entities/tasks/favorite) — `POST /v1/tasks/*/favorite`
- [Убрать задачу из избранного](/docs/entities/tasks/unfavorite) — `DELETE /v1/tasks/*/favorite`
- [Закрепить задачу](/docs/entities/tasks/pin) — `POST /v1/tasks/*/pin`
- [Открепить задачу](/docs/entities/tasks/unpin) — `DELETE /v1/tasks/*/pin`
- [Чат задачи](/docs/entities/tasks/chat) — `GET /v1/tasks/*/chat/messages`
- [Список записей по всему порталу](/docs/entities/tasks/time/global-list) — `GET /v1/task-time`
- [Поля записи учёта времени](/docs/entities/tasks/time/fields) — `GET /v1/task-time/fields`

### [Scrum: эпики и задачи](/docs/scrum) · `task`

- [Спринты](/docs/scrum/sprints) — обзор подраздела
- [Список спринтов](/docs/scrum/sprints/list) — `GET /v1/scrum/sprints`
- [Активный спринт](/docs/scrum/sprints/active) — `GET /v1/scrum/sprints/active`
- [Получить спринт](/docs/scrum/sprints/get) — `GET /v1/scrum/sprints/*`
- [Этапы Scrum-канбана](/docs/scrum/stages) — обзор подраздела
- [Список этапов](/docs/scrum/stages/list) — `GET /v1/scrum/sprints/*/stages`
- [Создать этап](/docs/scrum/stages/create) — `POST /v1/scrum/sprints/*/stages`
- [Обновить этап](/docs/scrum/stages/update) — `PATCH /v1/scrum/stages/*`
- [Эпики скрама](/docs/scrum/epics) — обзор подраздела
- [Список эпиков](/docs/scrum/epics/list) — `GET /v1/scrum/epics`
- [Создать эпик](/docs/scrum/epics/create) — `POST /v1/scrum/epics`
- [Получить эпик](/docs/scrum/epics/get) — `GET /v1/scrum/epics/*`
- [Обновить эпик](/docs/scrum/epics/update) — `PATCH /v1/scrum/epics/*`
- [Размещение задач в скраме](/docs/scrum/tasks) — обзор подраздела
- [Получить размещение задачи в скраме](/docs/scrum/tasks/get) — `GET /v1/scrum/tasks/*`
- [Разместить или переместить задачу в скраме](/docs/scrum/tasks/update) — `PATCH /v1/scrum/tasks/*`

### [История изменений задачи](/docs/task-history) · `task`

- [История изменений задачи](/docs/task-history) — `GET /v1/tasks/*/history`

### [Стадии канбана задач](/docs/task-stages) · `task`

- [Стадии канбана задач](/docs/task-stages) — `GET /v1/tasks/stages/*`

## Общение

### [Бот-платформа](/docs/bots) · `imbot`

- [Управление ботами](/docs/bots/management) — обзор подраздела
- [Зарегистрировать бота](/docs/bots/management/create) — `POST /v1/bots`
- [Список ботов](/docs/bots/management/list) — `GET /v1/bots`
- [Получить бота](/docs/bots/management/get) — `GET /v1/bots/*`
- [Обновить бота](/docs/bots/management/update) — `PATCH /v1/bots/*`
- [Удалить бота](/docs/bots/management/delete) — `DELETE /v1/bots/*`
- [Ревизия бот-платформы](/docs/bots/management/revision) — `GET /v1/bots/revision`
- [Повторная авторизация бота](/docs/bots/management/reauth) — `POST /v1/bots/*/reauth`
- [Перепривязка подписки на события](/docs/bots/management/resubscribe) — `POST /v1/bots/*/resubscribe`
- [События](/docs/bots/events) — обзор подраздела
- [Получить события (polling)](/docs/bots/events/polling) — `GET /v1/bots/*/events`
- [Сообщения](/docs/bots/messages) — обзор подраздела
- [Отправить сообщение](/docs/bots/messages/send) — `POST /v1/bots/*/messages`
- [Получить сообщение](/docs/bots/messages/get) — `GET /v1/bots/*/messages/*`
- [Обновить сообщение](/docs/bots/messages/update) — `PATCH /v1/bots/*/messages/*`
- [Удалить сообщение](/docs/bots/messages/delete) — `DELETE /v1/bots/*/messages/*`
- [Прочитать сообщения](/docs/bots/messages/read) — `POST /v1/bots/*/chats/*/read`
- [Контекст сообщения](/docs/bots/messages/context) — `GET /v1/bots/*/messages/*/context`
- [Интерфейс](/docs/bots/ui) — обзор подраздела
- [Добавить реакцию](/docs/bots/ui/reaction-add) — `POST /v1/bots/*/messages/*/reactions`
- [Удалить реакцию](/docs/bots/ui/reaction-delete) — `DELETE /v1/bots/*/messages/*/reactions`
- [Индикатор набора](/docs/bots/ui/typing) — `POST /v1/bots/*/typing`
- [Управление полем ввода](/docs/bots/ui/text-field) — `POST /v1/bots/*/text-field`
- [Чаты](/docs/bots/chats) — обзор подраздела
- [Создать чат](/docs/bots/chats/create) — `POST /v1/bots/*/chats`
- [Получить чат](/docs/bots/chats/get) — `GET /v1/bots/*/chats/*`
- [Обновить чат](/docs/bots/chats/update) — `PATCH /v1/bots/*/chats/*`
- [Покинуть чат](/docs/bots/chats/leave) — `POST /v1/bots/*/chats/*/leave`
- [Назначить владельца](/docs/bots/chats/set-owner) — `POST /v1/bots/*/chats/*/owner`
- [Добавить участников](/docs/bots/chats/user-add) — `POST /v1/bots/*/chats/*/users`
- [Список участников](/docs/bots/chats/user-list) — `GET /v1/bots/*/chats/*/users`
- [Удалить участника](/docs/bots/chats/user-delete) — `DELETE /v1/bots/*/chats/*/users`
- [Добавить менеджеров](/docs/bots/chats/manager-add) — `POST /v1/bots/*/chats/*/managers`
- [Удалить менеджеров](/docs/bots/chats/manager-delete) — `DELETE /v1/bots/*/chats/*/managers`
- [Команды](/docs/bots/commands) — обзор подраздела
- [Зарегистрировать команду](/docs/bots/commands/register) — `POST /v1/bots/*/commands`
- [Список команд](/docs/bots/commands/list) — `GET /v1/bots/*/commands`
- [Обновить команду](/docs/bots/commands/update) — `PATCH /v1/bots/*/commands/*`
- [Удалить команду](/docs/bots/commands/delete) — `DELETE /v1/bots/*/commands/*`
- [Ответить на команду](/docs/bots/commands/answer) — `POST /v1/bots/*/commands/*/answer`
- [Файлы](/docs/bots/files) — обзор подраздела
- [Загрузить файл](/docs/bots/files/upload) — `POST /v1/bots/*/files`
- [Скачать файл](/docs/bots/files/download) — `GET /v1/bots/*/files/*`
- [Перенос владения ботом](/docs/bots/management/transfer) — `POST /v1/bots/*/transfer`

### [Звонки](/docs/calls) · `call`

- [Follow-up звонков](/docs/calls/followup) — обзор подраздела
- [Список Follow-up](/docs/calls/followup/list) — `POST /v1/calls/followups/list`
- [Follow-up по одному звонку](/docs/calls/followup/get) — `GET /v1/calls/followups/*`

### [Чаты](/docs/chats) · `im`

- [Поиск чатов](/docs/chats/discovery) — обзор подраздела
- [Последние диалоги](/docs/chats/discovery/recent) — `GET /v1/chats/recent`
- [Найти чат CRM-сущности](/docs/chats/discovery/find) — `GET /v1/chats/find`
- [Поиск чатов по тексту](/docs/chats/discovery/search) — `GET /v1/chats/search`
- [Файлы](/docs/chats/files) — обзор подраздела
- [Метаданные файла](/docs/chats/files/file-get) — `GET /v1/chats/files/*`
- [Информация о диалоге](/docs/chats/discovery/get) — `GET /v1/chats/*`
- [Сообщения](/docs/chats/messages) — обзор подраздела
- [Чтение сообщений](/docs/chats/messages/list) — `GET /v1/chats/*/messages`
- [Отправить сообщение](/docs/chats/messages/send) — `POST /v1/chats/*/messages`
- [Редактировать сообщение](/docs/chats/messages/update) — `PATCH /v1/chats/*/messages/*`
- [Удалить сообщение](/docs/chats/messages/delete) — `DELETE /v1/chats/*/messages/*`
- [Управление чатами](/docs/chats/management) — обзор подраздела
- [Создать групповой чат](/docs/chats/management/create) — `POST /v1/chats`
- [Переименовать чат](/docs/chats/management/rename) — `PATCH /v1/chats/*`
- [Покинуть чат](/docs/chats/management/leave) — `POST /v1/chats/*/leave`
- [Участники](/docs/chats/members) — обзор подраздела
- [Список участников](/docs/chats/members/list) — `GET /v1/chats/*/users`
- [Добавить участников](/docs/chats/members/add) — `POST /v1/chats/*/users`
- [Удалить участника](/docs/chats/members/remove) — `DELETE /v1/chats/*/users`
- [Загрузить файл в чат](/docs/chats/files/upload) — `POST /v1/chats/*/files`
- [Папка чата на Диске](/docs/chats/files/folder) — `GET /v1/chats/*/folder`
- [Отметить прочитанным](/docs/chats/messages/read) — `POST /v1/chats/*/read`
- [Массовая загрузка сообщений](/docs/chats/messages/bulk) — `POST /v1/chats/messages/bulk`
- [События](/docs/chats/events) — обзор подраздела
- [Подписаться на события](/docs/chats/events/subscribe) — `POST /v1/chats/events/subscribe`
- [Отписаться от событий](/docs/chats/events/unsubscribe) — `POST /v1/chats/events/unsubscribe`

### [Лента новостей](/docs/feed) · `log`

- [Посты](/docs/feed/posts) — обзор подраздела
- [Список постов](/docs/feed/posts/list) — `GET /v1/posts`
- [Создать пост](/docs/feed/posts/create) — `POST /v1/posts`
- [Обновить пост](/docs/feed/posts/update) — `PATCH /v1/posts/*`
- [Удалить пост](/docs/feed/posts/delete) — `DELETE /v1/posts/*`
- [Добавить получателей](/docs/feed/posts/share) — `POST /v1/posts/*/share`
- [Комментарии](/docs/feed/comments) — обзор подраздела
- [Добавить комментарий](/docs/feed/comments/add) — `POST /v1/posts/*/comments`
- [Удалить комментарий](/docs/feed/comments/delete) — `DELETE /v1/posts/*/comments/*`

### [Почта](/docs/mail) · `mail`

- [Почтовые ящики](/docs/mail/mailboxes) — обзор подраздела
- [Список почтовых ящиков](/docs/mail/mailboxes/list) — `GET /v1/mail/mailboxes`
- [Получить почтовый ящик](/docs/mail/mailboxes/get) — `GET /v1/mail/mailboxes/*`
- [Письма](/docs/mail/messages) — обзор подраздела
- [Список писем](/docs/mail/messages/list) — `GET /v1/mail/messages`
- [Отправить письмо](/docs/mail/messages/send) — `POST /v1/mail/messages`
- [Адреса отправителя ящика](/docs/mail/mailboxes/senders) — `GET /v1/mail/mailboxes/*/senders`

### [Уведомления](/docs/notifications) · `im`

- [Отправить уведомление](/docs/notifications/send) — `POST /v1/notifications`
- [Лента уведомлений](/docs/notifications/list) — `GET /v1/notifications`
- [Отметить прочитанными](/docs/notifications/read) — `POST /v1/notifications/read`
- [Удалить по идентификатору](/docs/notifications/delete) — `DELETE /v1/notifications/*`
- [Удалить по метке](/docs/notifications/delete-by-tag) — `DELETE /v1/notifications/by-tag/*`
- [Словарь типов уведомлений](/docs/notifications/schema) — `GET /v1/notifications/schema`

### [Открытые линии](/docs/openlines) · `imopenlines`

- [Конфигурации открытых линий](/docs/openlines/config) — обзор подраздела
- [Получить конфигурацию открытой линии](/docs/openlines/config/get) — `GET /v1/openline-configs/*`
- [Обновить конфигурацию открытой линии](/docs/openlines/config/update) — `PATCH /v1/openline-configs/*`
- [Удалить конфигурацию открытой линии](/docs/openlines/config/delete) — `DELETE /v1/openline-configs/*`
- [Агрегация конфигураций открытых линий](/docs/openlines/config/aggregate) — `POST /v1/openline-configs/aggregate`
- [Поля конфигурации открытой линии](/docs/openlines/config/fields) — `GET /v1/openline-configs/fields`
- [Список конфигураций открытых линий](/docs/openlines/config/list) — `GET /v1/openline-configs`
- [Создать конфигурацию открытой линии](/docs/openlines/config/create) — `POST /v1/openline-configs`
- [Поиск конфигураций открытых линий](/docs/openlines/config/search) — `POST /v1/openline-configs/search`
- [Агрегаты по линии за период](/docs/openlines/stats) — `POST /v1/openlines/stats`
- [Операторы в реальном времени](/docs/openlines/operators) — `GET /v1/openlines/operators`
- [Список сессий](/docs/openlines/sessions) — `POST /v1/openlines/sessions/search`
- [Метрики по сессиям](/docs/openlines/sessions/stats) — `POST /v1/openlines/sessions/stats`
- [Оценки (CSAT)](/docs/openlines/ratings) — `POST /v1/openlines/ratings/search`
- [История переназначений](/docs/openlines/sessions/transfers) — `POST /v1/openlines/sessions/transfers`

### [Телефония](/docs/telephony) · `telephony`

- [Линии](/docs/telephony/lines) — обзор подраздела
- [Список линий приложения](/docs/telephony/lines/list) — `GET /v1/telephony-lines` `POST /v1/telephony-lines/aggregate`
- [Добавить линию](/docs/telephony/lines/create) — `POST /v1/telephony-lines`
- [Обновить линию](/docs/telephony/lines/update) — `PATCH /v1/telephony-lines/*`
- [Удалить линию](/docs/telephony/lines/delete) — `DELETE /v1/telephony-lines/*`
- [Поиск линий приложения](/docs/telephony/lines/search) — `POST /v1/telephony-lines/search`
- [Поля линии приложения](/docs/telephony/lines/fields) — `GET /v1/telephony-lines/fields`
- [Звонки в CRM](/docs/telephony/crm) — обзор подраздела
- [Зарегистрировать звонок](/docs/telephony/crm/register) — `POST /v1/calls/register`
- [Завершить звонок](/docs/telephony/crm/finish) — `POST /v1/calls/*/finish`
- [Показать карточку звонка](/docs/telephony/crm/show) — `POST /v1/calls/*/show`
- [Скрыть карточку звонка](/docs/telephony/crm/hide) — `POST /v1/calls/*/hide`
- [Прикрепить транскрипцию](/docs/telephony/crm/transcription) — `POST /v1/calls/*/transcription`
- [Исходящие звонки](/docs/telephony/outbound) — обзор подраздела
- [Запустить автозвонок с синтезом речи](/docs/telephony/outbound/auto-call) — `POST /v1/calls/auto-call`
- [Запустить автозвонок с воспроизведением аудиофайла](/docs/telephony/outbound/auto-call-audio) — `POST /v1/calls/auto-call-audio`
- [Инициировать обратный звонок](/docs/telephony/outbound/callback) — `POST /v1/calls/callback`
- [Аналитика и справочники](/docs/telephony/analytics) — обзор подраздела
- [Статистика звонков](/docs/telephony/analytics/statistics) — `GET /v1/calls/statistics`
- [Справочник голосов](/docs/telephony/analytics/voices) — `GET /v1/calls/voices`
- [Линии Voximplant](/docs/telephony/lines/voximplant) — `GET /v1/voximplant-lines`

## Сотрудники

### [Отделы](/docs/entities/departments) · `department`

- [Список отделов](/docs/entities/departments/list) — `GET /v1/departments`
- [Создать отдел](/docs/entities/departments/create) — `POST /v1/departments`
- [Получить отдел](/docs/entities/departments/get) — `GET /v1/departments/*`
- [Обновить отдел](/docs/entities/departments/update) — `PATCH /v1/departments/*`
- [Удалить отдел](/docs/entities/departments/delete) — `DELETE /v1/departments/*`
- [Поиск отделов](/docs/entities/departments/search) — `POST /v1/departments/search`
- [Поля отдела](/docs/entities/departments/fields) — `GET /v1/departments/fields`

### [Пользователи](/docs/entities/users) · `user`

- [Список сотрудников](/docs/entities/users/list) — `GET /v1/users`
- [Создать сотрудника](/docs/entities/users/create) — `POST /v1/users`
- [Получить сотрудника](/docs/entities/users/get) — `GET /v1/users/*`
- [Обновить сотрудника](/docs/entities/users/update) — `PATCH /v1/users/*`
- [Поиск сотрудников](/docs/entities/users/search) — `POST /v1/users/search`
- [Агрегация сотрудников](/docs/entities/users/aggregate) — `POST /v1/users/aggregate`
- [Поля сотрудника](/docs/entities/users/fields) — `GET /v1/users/fields`
- [Профиль текущего сотрудника](/docs/entities/users/me) — `GET /v1/users/me`
- [Удалить фотографию сотрудника](/docs/entities/users/photo-delete) — `DELETE /v1/users/*/personal-photo`

### [Рабочие группы](/docs/entities/workgroups) · `sonet_group`

- [Список рабочих групп](/docs/entities/workgroups/list) — `GET /v1/workgroups`
- [Создать рабочую группу](/docs/entities/workgroups/create) — `POST /v1/workgroups`
- [Получить рабочую группу](/docs/entities/workgroups/get) — `GET /v1/workgroups/*`
- [Обновить рабочую группу](/docs/entities/workgroups/update) — `PATCH /v1/workgroups/*`
- [Удалить рабочую группу](/docs/entities/workgroups/delete) — `DELETE /v1/workgroups/*`
- [Поиск рабочих групп](/docs/entities/workgroups/search) — `POST /v1/workgroups/search`
- [Агрегация рабочих групп](/docs/entities/workgroups/aggregate) — `POST /v1/workgroups/aggregate`
- [Поля рабочей группы](/docs/entities/workgroups/fields) — `GET /v1/workgroups/fields`
- [Участники рабочей группы](/docs/entities/workgroups/users) — `GET /v1/workgroups/*/users`

### [Оргструктура](/docs/humanresources) · `humanresources`

- [Узлы оргструктуры](/docs/humanresources/nodes) — обзор подраздела
- [Список узлов](/docs/humanresources/nodes/list) — `GET /v1/humanresources/nodes`
- [Создать узел](/docs/humanresources/nodes/create) — `POST /v1/humanresources/nodes`
- [Получить узел](/docs/humanresources/nodes/get) — `GET /v1/humanresources/nodes/*`
- [Обновить узел](/docs/humanresources/nodes/update) — `PATCH /v1/humanresources/nodes/*`
- [Поля узла оргструктуры](/docs/humanresources/nodes/fields) — `GET /v1/humanresources/nodes/fields`
- [Поиск узлов](/docs/humanresources/nodes/search) — `POST /v1/humanresources/nodes/search`

### [Рабочий день](/docs/workday) · `timeman`

- [Открыть рабочий день](/docs/workday/open) — `POST /v1/workday/open`
- [Закрыть рабочий день](/docs/workday/close) — `POST /v1/workday/close`
- [Поставить на паузу](/docs/workday/pause) — `POST /v1/workday/pause`
- [Текущий статус](/docs/workday/status) — `GET /v1/workday/status`
- [Настройки учёта](/docs/workday/settings) — `GET /v1/workday/settings`
- [График работы](/docs/workday/schedule) — `GET /v1/workday/schedule`
- [История рабочего дня](/docs/workday/records) — `GET /v1/workday/records`

## Контент и файлы

### [Шаблоны документов](/docs/entities/doc-templates) · `disk` `documentgenerator`

- [Список шаблонов](/docs/entities/doc-templates/list) — `GET /v1/doc-templates`
- [Создать шаблон](/docs/entities/doc-templates/create) — `POST /v1/doc-templates`
- [Получить шаблон](/docs/entities/doc-templates/get) — `GET /v1/doc-templates/*`
- [Обновить шаблон](/docs/entities/doc-templates/update) — `PATCH /v1/doc-templates/*`
- [Удалить шаблон](/docs/entities/doc-templates/delete) — `DELETE /v1/doc-templates/*`
- [Поиск шаблонов](/docs/entities/doc-templates/search) — `POST /v1/doc-templates/search`
- [Агрегация шаблонов документов](/docs/entities/doc-templates/aggregate) — `POST /v1/doc-templates/aggregate`
- [Поля шаблона](/docs/entities/doc-templates/fields) — `GET /v1/doc-templates/fields`

### [Документы](/docs/entities/documents) · `crm` `documentgenerator`

- [Список документов](/docs/entities/documents/list) — `GET /v1/documents`
- [Создать документ](/docs/entities/documents/create) — `POST /v1/documents`
- [Получить документ](/docs/entities/documents/get) — `GET /v1/documents/*`
- [Обновить документ](/docs/entities/documents/update) — `PATCH /v1/documents/*`
- [Удалить документ](/docs/entities/documents/delete) — `DELETE /v1/documents/*`
- [Поиск документов](/docs/entities/documents/search) — `POST /v1/documents/search`
- [Поля документа](/docs/entities/documents/fields) — `GET /v1/documents/fields`
- [Документы по CRM-сущности](/docs/entities/documents/crm-list) — `GET /v1/crm-documents`

### [Файлы](/docs/entities/files) · `disk`

- [Список файлов папки](/docs/entities/files/list) — `GET /v1/files`
- [Получить файл](/docs/entities/files/get) — `GET /v1/files/*`
- [Переименовать файл](/docs/entities/files/update) — `PATCH /v1/files/*`
- [Удалить файл](/docs/entities/files/delete) — `DELETE /v1/files/*`
- [Поиск файлов](/docs/entities/files/search) — `POST /v1/files/search`
- [Поля файла](/docs/entities/files/fields) — `GET /v1/files/fields`
- [Загрузить файл](/docs/entities/files/upload) — `POST /v1/files/upload`
- [Скачать файл](/docs/entities/files/download) — `GET /v1/files/*/download`
- [Переместить файл](/docs/entities/files/moveto) — `POST /v1/files/*/moveto`
- [Скопировать файл](/docs/entities/files/copyto) — `POST /v1/files/*/copyto`

### [Папки](/docs/entities/folders) · `disk`

- [Список содержимого папки](/docs/entities/folders/list) — `GET /v1/folders`
- [Создать папку](/docs/entities/folders/create) — `POST /v1/folders`
- [Получить папку](/docs/entities/folders/get) — `GET /v1/folders/*`
- [Переименовать папку](/docs/entities/folders/update) — `PATCH /v1/folders/*`
- [Удалить папку](/docs/entities/folders/delete) — `DELETE /v1/folders/*`
- [Поиск папок](/docs/entities/folders/search) — `POST /v1/folders/search`
- [Поля папки](/docs/entities/folders/fields) — `GET /v1/folders/fields`
- [Переместить папку](/docs/entities/folders/moveto) — `POST /v1/folders/*/moveto`
- [Скопировать папку](/docs/entities/folders/copyto) — `POST /v1/folders/*/copyto`

### [Страницы](/docs/entities/pages) · `landing`

- [Список страниц](/docs/entities/pages/list) — `GET /v1/pages`
- [Создать страницу](/docs/entities/pages/create) — `POST /v1/pages`
- [Получить страницу](/docs/entities/pages/get) — `GET /v1/pages/*`
- [Обновить страницу](/docs/entities/pages/update) — `PATCH /v1/pages/*`
- [Удалить страницу](/docs/entities/pages/delete) — `DELETE /v1/pages/*`
- [Поиск страниц](/docs/entities/pages/search) — `POST /v1/pages/search`
- [Агрегация страниц](/docs/entities/pages/aggregate) — `POST /v1/pages/aggregate`
- [Поля страницы](/docs/entities/pages/fields) — `GET /v1/pages/fields`

### [Сайты](/docs/entities/sites) · `landing`

- [Список сайтов](/docs/entities/sites/list) — `GET /v1/sites`
- [Создать сайт](/docs/entities/sites/create) — `POST /v1/sites`
- [Получить сайт](/docs/entities/sites/get) — `GET /v1/sites/*`
- [Обновить сайт](/docs/entities/sites/update) — `PATCH /v1/sites/*`
- [Удалить сайт](/docs/entities/sites/delete) — `DELETE /v1/sites/*`
- [Поиск сайтов](/docs/entities/sites/search) — `POST /v1/sites/search`
- [Агрегация сайтов](/docs/entities/sites/aggregate) — `POST /v1/sites/aggregate`
- [Поля сайта](/docs/entities/sites/fields) — `GET /v1/sites/fields`

### [Хранилища](/docs/entities/storages) · `disk`

- [Список хранилищ](/docs/entities/storages/list) — `GET /v1/storages`
- [Получить хранилище](/docs/entities/storages/get) — `GET /v1/storages/*`
- [Поиск хранилищ](/docs/entities/storages/search) — `POST /v1/storages/search`
- [Поля хранилища](/docs/entities/storages/fields) — `GET /v1/storages/fields`
- [Содержимое корня хранилища](/docs/entities/storages/children) — `POST /v1/storages/*/children`

### [Универсальные списки](/docs/lists) · `lists`

- [Списки](/docs/lists/lists) — обзор подраздела
- [Список списков](/docs/lists/lists/list) — `GET /v1/lists`
- [Создать список](/docs/lists/lists/create) — `POST /v1/lists`
- [Получить список](/docs/lists/lists/get) — `GET /v1/lists/*`
- [Обновить список](/docs/lists/lists/update) — `PATCH /v1/lists/*`
- [Удалить список](/docs/lists/lists/delete) — `DELETE /v1/lists/*`
- [Тип инфоблока](/docs/lists/lists/type) — `GET /v1/lists/*/type`
- [Поля списка](/docs/lists/fields) — обзор подраздела
- [Поля списка](/docs/lists/fields/list) — `GET /v1/lists/*/fields`
- [Создать поле](/docs/lists/fields/create) — `POST /v1/lists/*/fields`
- [Получить поле](/docs/lists/fields/get) — `GET /v1/lists/*/fields/*`
- [Обновить поле](/docs/lists/fields/update) — `PATCH /v1/lists/*/fields/*`
- [Удалить поле](/docs/lists/fields/delete) — `DELETE /v1/lists/*/fields/*`
- [Типы полей](/docs/lists/fields/field-types) — `GET /v1/lists/*/field-types`
- [Разделы](/docs/lists/sections) — обзор подраздела
- [Разделы списка](/docs/lists/sections/list) — `GET /v1/lists/*/sections`
- [Создать раздел](/docs/lists/sections/create) — `POST /v1/lists/*/sections`
- [Получить раздел](/docs/lists/sections/get) — `GET /v1/lists/*/sections/*`
- [Обновить раздел](/docs/lists/sections/update) — `PATCH /v1/lists/*/sections/*`
- [Удалить раздел](/docs/lists/sections/delete) — `DELETE /v1/lists/*/sections/*`
- [Элементы](/docs/lists/elements) — обзор подраздела
- [Элементы списка](/docs/lists/elements/list) — `GET /v1/lists/*/elements`
- [Создать элемент](/docs/lists/elements/create) — `POST /v1/lists/*/elements`
- [Получить элемент](/docs/lists/elements/get) — `GET /v1/lists/*/elements/*`
- [Обновить элемент](/docs/lists/elements/update) — `PATCH /v1/lists/*/elements/*`
- [Удалить элемент](/docs/lists/elements/delete) — `DELETE /v1/lists/*/elements/*`
- [Файлы свойства элемента](/docs/lists/elements/files) — `GET /v1/lists/*/elements/*/files/*`

### [База знаний](/docs/note) · `note`

- [Базы знаний](/docs/note/collections) — обзор подраздела
- [Список баз знаний](/docs/note/collections/list) — `GET /v1/note/collections`
- [Создать базу знаний](/docs/note/collections/create) — `POST /v1/note/collections`
- [Получить базу знаний](/docs/note/collections/get) — `GET /v1/note/collections/*`
- [Переименовать базу знаний](/docs/note/collections/update) — `PATCH /v1/note/collections/*`
- [Удалить базу знаний](/docs/note/collections/delete) — `DELETE /v1/note/collections/*`
- [Архивировать базу знаний](/docs/note/collections/archive) — `POST /v1/note/collections/*/archive`
- [Дерево документов базы знаний](/docs/note/collections/tree) — `GET /v1/note/collections/*/documents`
- [Документы](/docs/note/documents) — обзор подраздела
- [Создать документ](/docs/note/documents/create) — `POST /v1/note/documents`
- [Поиск документов](/docs/note/documents/search) — `GET /v1/note/documents/search`
- [Получить документ](/docs/note/documents/get) — `GET /v1/note/documents/*`
- [Обновить документ](/docs/note/documents/update) — `PATCH /v1/note/documents/*`
- [Удалить документ](/docs/note/documents/delete) — `DELETE /v1/note/documents/*`
- [Архивировать документ](/docs/note/documents/archive) — `POST /v1/note/documents/*/archive`
- [Файлы](/docs/note/files) — обзор подраздела
- [Загрузить файл](/docs/note/files/upload) — `POST /v1/note/documents/*/files`
- [Получить метаданные файла](/docs/note/files/get) — `GET /v1/note/documents/*/files/*`

## Продажи и склад

### [Позиции корзины](/docs/entities/basket-items) · `sale`

- [Список позиций корзины](/docs/entities/basket-items/list) — `GET /v1/basket-items`
- [Добавить позицию в корзину](/docs/entities/basket-items/create) — `POST /v1/basket-items`
- [Получить позицию корзины](/docs/entities/basket-items/get) — `GET /v1/basket-items/*`
- [Обновить позицию корзины](/docs/entities/basket-items/update) — `PATCH /v1/basket-items/*`
- [Удалить позицию корзины](/docs/entities/basket-items/delete) — `DELETE /v1/basket-items/*`
- [Поиск позиций корзины](/docs/entities/basket-items/search) — `POST /v1/basket-items/search`
- [Агрегация позиций корзины](/docs/entities/basket-items/aggregate) — `POST /v1/basket-items/aggregate`
- [Поля позиции корзины](/docs/entities/basket-items/fields) — `GET /v1/basket-items/fields`

### [Типы цен каталога](/docs/entities/catalog-price-types) · `catalog`

- [Список типов цен](/docs/entities/catalog-price-types/list) — `GET /v1/catalog-price-types`
- [Получить тип цены](/docs/entities/catalog-price-types/get) — `GET /v1/catalog-price-types/*`
- [Поиск типов цен](/docs/entities/catalog-price-types/search) — `POST /v1/catalog-price-types/search`
- [Поля типа цены](/docs/entities/catalog-price-types/fields) — `GET /v1/catalog-price-types/fields`

### [Цены каталога](/docs/entities/catalog-prices) · `catalog`

- [Список цен](/docs/entities/catalog-prices/list) — `GET /v1/catalog-prices`
- [Создать цену](/docs/entities/catalog-prices/create) — `POST /v1/catalog-prices`
- [Получить цену](/docs/entities/catalog-prices/get) — `GET /v1/catalog-prices/*`
- [Обновить цену](/docs/entities/catalog-prices/update) — `PATCH /v1/catalog-prices/*`
- [Удалить цену](/docs/entities/catalog-prices/delete) — `DELETE /v1/catalog-prices/*`
- [Поиск цен](/docs/entities/catalog-prices/search) — `POST /v1/catalog-prices/search`
- [Поля цены](/docs/entities/catalog-prices/fields) — `GET /v1/catalog-prices/fields`

### [Свойства товаров каталога](/docs/entities/catalog-product-properties) · `catalog`

- [Список свойств](/docs/entities/catalog-product-properties/list) — `GET /v1/catalog-product-properties`
- [Создать свойство товара](/docs/entities/catalog-product-properties/create) — `POST /v1/catalog-product-properties`
- [Получить свойство](/docs/entities/catalog-product-properties/get) — `GET /v1/catalog-product-properties/*`
- [Обновить свойство](/docs/entities/catalog-product-properties/update) — `PATCH /v1/catalog-product-properties/*`
- [Удалить свойство](/docs/entities/catalog-product-properties/delete) — `DELETE /v1/catalog-product-properties/*`
- [Поиск свойств товаров](/docs/entities/catalog-product-properties/search) — `POST /v1/catalog-product-properties/search`
- [Поля свойства](/docs/entities/catalog-product-properties/fields) — `GET /v1/catalog-product-properties/fields`

### [Значения списочных свойств каталога](/docs/entities/catalog-product-property-enums) · `catalog`

- [Список значений](/docs/entities/catalog-product-property-enums/list) — `GET /v1/catalog-product-property-enums`
- [Получить значение](/docs/entities/catalog-product-property-enums/get) — `GET /v1/catalog-product-property-enums/*`
- [Поиск значений](/docs/entities/catalog-product-property-enums/search) — `POST /v1/catalog-product-property-enums/search`
- [Поля значения](/docs/entities/catalog-product-property-enums/fields) — `GET /v1/catalog-product-property-enums/fields`

### [Товары каталога](/docs/entities/catalog-products) · `catalog`

- [Список товаров каталога](/docs/entities/catalog-products/list) — `GET /v1/catalog-products`
- [Создать товар каталога](/docs/entities/catalog-products/create) — `POST /v1/catalog-products`
- [Получить товар каталога](/docs/entities/catalog-products/get) — `GET /v1/catalog-products/*`
- [Обновить товар каталога](/docs/entities/catalog-products/update) — `PATCH /v1/catalog-products/*`
- [Удалить товар каталога](/docs/entities/catalog-products/delete) — `DELETE /v1/catalog-products/*`
- [Поиск товаров каталога](/docs/entities/catalog-products/search) — `POST /v1/catalog-products/search`
- [Агрегация товаров каталога](/docs/entities/catalog-products/aggregate) — `POST /v1/catalog-products/aggregate`
- [Поля товара каталога](/docs/entities/catalog-products/fields) — `GET /v1/catalog-products/fields`
- [Изображения товара](/docs/entities/catalog-products/images) — `GET /v1/catalog-products/*/images` `GET /v1/catalog-products/*/images/*`

### [Разделы каталога](/docs/entities/catalog-sections) · `catalog`

- [Список разделов](/docs/entities/catalog-sections/list) — `GET /v1/catalog-sections`
- [Создать раздел](/docs/entities/catalog-sections/create) — `POST /v1/catalog-sections`
- [Получить раздел](/docs/entities/catalog-sections/get) — `GET /v1/catalog-sections/*`
- [Обновить раздел](/docs/entities/catalog-sections/update) — `PATCH /v1/catalog-sections/*`
- [Удалить раздел](/docs/entities/catalog-sections/delete) — `DELETE /v1/catalog-sections/*`
- [Поиск разделов](/docs/entities/catalog-sections/search) — `POST /v1/catalog-sections/search`
- [Поля раздела](/docs/entities/catalog-sections/fields) — `GET /v1/catalog-sections/fields`

### [Каталоги](/docs/entities/catalogs) · `catalog`

- [Список каталогов](/docs/entities/catalogs/list) — `GET /v1/catalogs`
- [Получить каталог](/docs/entities/catalogs/get) — `GET /v1/catalogs/*`
- [Поиск каталогов](/docs/entities/catalogs/search) — `POST /v1/catalogs/search`
- [Поля каталога](/docs/entities/catalogs/fields) — `GET /v1/catalogs/fields`

### [Статусы заказов](/docs/entities/order-statuses) · `sale`

- [Список статусов заказов](/docs/entities/order-statuses/list) — `GET /v1/order-statuses`
- [Создать статус заказа](/docs/entities/order-statuses/create) — `POST /v1/order-statuses`
- [Получить статус заказа](/docs/entities/order-statuses/get) — `GET /v1/order-statuses/*`
- [Обновить статус заказа](/docs/entities/order-statuses/update) — `PATCH /v1/order-statuses/*`
- [Удалить статус заказа](/docs/entities/order-statuses/delete) — `DELETE /v1/order-statuses/*`
- [Поиск статусов заказов](/docs/entities/order-statuses/search) — `POST /v1/order-statuses/search`
- [Агрегация статусов заказов](/docs/entities/order-statuses/aggregate) — `POST /v1/order-statuses/aggregate`
- [Поля статуса заказа](/docs/entities/order-statuses/fields) — `GET /v1/order-statuses/fields`

### [Заказы](/docs/entities/orders) · `sale`

- [Список заказов](/docs/entities/orders/list) — `GET /v1/orders`
- [Создать заказ](/docs/entities/orders/create) — `POST /v1/orders`
- [Получить заказ](/docs/entities/orders/get) — `GET /v1/orders/*`
- [Обновить заказ](/docs/entities/orders/update) — `PATCH /v1/orders/*`
- [Удалить заказ](/docs/entities/orders/delete) — `DELETE /v1/orders/*`
- [Поиск заказов](/docs/entities/orders/search) — `POST /v1/orders/search`
- [Агрегация заказов](/docs/entities/orders/aggregate) — `POST /v1/orders/aggregate`
- [Поля заказа](/docs/entities/orders/fields) — `GET /v1/orders/fields`

### [Оплаты](/docs/entities/payments) · `sale`

- [Список оплат](/docs/entities/payments/list) — `GET /v1/payments`
- [Создать оплату](/docs/entities/payments/create) — `POST /v1/payments`
- [Получить оплату](/docs/entities/payments/get) — `GET /v1/payments/*`
- [Обновить оплату](/docs/entities/payments/update) — `PATCH /v1/payments/*`
- [Удалить оплату](/docs/entities/payments/delete) — `DELETE /v1/payments/*`
- [Поиск оплат](/docs/entities/payments/search) — `POST /v1/payments/search`
- [Агрегация оплат](/docs/entities/payments/aggregate) — `POST /v1/payments/aggregate`
- [Поля оплаты](/docs/entities/payments/fields) — `GET /v1/payments/fields`

### [Склады](/docs/entities/warehouses) · `catalog`

- [Список складов](/docs/entities/warehouses/list) — `GET /v1/warehouses`
- [Создать склад](/docs/entities/warehouses/create) — `POST /v1/warehouses`
- [Получить склад](/docs/entities/warehouses/get) — `GET /v1/warehouses/*`
- [Обновить склад](/docs/entities/warehouses/update) — `PATCH /v1/warehouses/*`
- [Удалить склад](/docs/entities/warehouses/delete) — `DELETE /v1/warehouses/*`
- [Остатки склада](/docs/entities/warehouses/stock) — `GET /v1/warehouses/*/stock`
- [Сводные остатки по товарам](/docs/entities/warehouses/stock-totals) — `GET /v1/warehouses/stock/totals`

### [Интеграция 1С](/docs/onec) · `vibe:onec`

- [Каталог инструментов 1С](/docs/onec/tools) — `GET /v1/onec/tools`
- [Запросить данные из 1С](/docs/onec/call) — `POST /v1/onec/tools/*/call`
- [Получить результат операции 1С](/docs/onec/operation) — `GET /v1/onec/operations/*`

## Бизнес-процессы

### [Действия бизнес-процессов](/docs/entities/bizproc-activities) · `bizproc`

- [Список действий](/docs/entities/bizproc-activities/list) — `GET /v1/bizproc-activities`
- [Зарегистрировать действие](/docs/entities/bizproc-activities/create) — `POST /v1/bizproc-activities`
- [Обновить действие](/docs/entities/bizproc-activities/update) — `PATCH /v1/bizproc-activities/*`
- [Удалить действие](/docs/entities/bizproc-activities/delete) — `DELETE /v1/bizproc-activities/*`
- [Поля действия](/docs/entities/bizproc-activities/fields) — `GET /v1/bizproc-activities/fields`

### [Роботы бизнес-процессов](/docs/entities/bizproc-robots) · `bizproc`

- [Список роботов](/docs/entities/bizproc-robots/list) — `GET /v1/bizproc-robots`
- [Зарегистрировать робота](/docs/entities/bizproc-robots/create) — `POST /v1/bizproc-robots`
- [Обновить робота](/docs/entities/bizproc-robots/update) — `PATCH /v1/bizproc-robots/*`
- [Удалить робота](/docs/entities/bizproc-robots/delete) — `DELETE /v1/bizproc-robots/*`
- [Поля робота](/docs/entities/bizproc-robots/fields) — `GET /v1/bizproc-robots/fields`

### [Шаблоны бизнес-процессов](/docs/entities/bizproc-templates) · `bizproc`

- [Список шаблонов](/docs/entities/bizproc-templates/list) — `GET /v1/bizproc-templates`
- [Загрузить шаблон](/docs/entities/bizproc-templates/create) — `POST /v1/bizproc-templates`
- [Обновить шаблон](/docs/entities/bizproc-templates/update) — `PATCH /v1/bizproc-templates/*`
- [Удалить шаблон](/docs/entities/bizproc-templates/delete) — `DELETE /v1/bizproc-templates/*`
- [Поиск шаблонов](/docs/entities/bizproc-templates/search) — `POST /v1/bizproc-templates/search`
- [Поля шаблона](/docs/entities/bizproc-templates/fields) — `GET /v1/bizproc-templates/fields`

### [Обратная связь](/docs/feedback)

- [Отправить обращение](/docs/feedback/submit) — `POST /v1/feedback`
- [Список обращений](/docs/feedback/list) — `GET /v1/feedback`
- [Получить обращение](/docs/feedback/get) — `GET /v1/feedback/*`
- [Обновить обращение](/docs/feedback/update) — `PATCH /v1/feedback/*`
- [Добавить комментарий](/docs/feedback/comments) — `POST /v1/feedback/*/comments`
- [Загрузить вложение](/docs/feedback/attachments) — `POST /v1/feedback/attachments`

<!-- END GENERATED: api-reference-hub -->

## Общие возможности

Все эндпоинты сущностей поддерживают:

- **[Фильтрация](/docs/filtering):** `?filter[stageId]=NEW` или `?filter[$gte][amount]=1000` (MongoDB-операторы)
- **Сортировка:** `?sort=-createdAt` (префикс `-` для сортировки по убыванию)
- **Пагинация:** `?limit=50&offset=100` (автопагинация при limit > 50)
- **Выбор полей:** `?select=id,title,amount`
- **Трансформация полей:** camelCase-имена автоматически конвертируются в имена полей Битрикс24
- **Метаданные полей:** `GET /v1/{entity}/fields` возвращает описание полей, включая пользовательские UF-поля с подписями. Для полей-перечислений возвращается массив `items` с доступными значениями
- **Поиск:** `POST /v1/{entity}/search` — расширенный поиск с автоматическим разбиением по датам для больших наборов данных
- **Агрегация:** `POST /v1/{entity}/aggregate` — подсчёт, сумма, среднее, минимум, максимум по полям
- **Товарные позиции:** для CRM-сущностей с товарами (сделки, лиды, предложения, счета, элементы смарт-процессов) доступны маршруты `GET/POST/PUT/PATCH/DELETE /v1/{entity}/{id}/products`
- **[Связанные данные (include)](/docs/includes):** `?include=company,contact` загружает связанные сущности в одном запросе