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

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

Страница каждой сущности перечисляет её операции, а у каждой операции своя страница с параметрами, примерами и кодами ошибок. Начните с раздела ниже.

## Сущности по разделам

### CRM

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Сделки](/docs/entities/deals) | `/v1/deals` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |
| [Контакты](/docs/entities/contacts) | `/v1/contacts` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Компании](/docs/entities/companies) | `/v1/companies` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Лиды](/docs/entities/leads) | `/v1/leads` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |
| [Предложения](/docs/entities/quotes) | `/v1/quotes` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |
| [Счета](/docs/entities/invoices) | `/v1/invoices` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |
| [Воронки сделок](/docs/entities/deal-categories) | `/v1/deal-categories` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Воронки](/docs/entities/categories) | `/v1/categories/:entityTypeId` | `list` `get` `create` `update` `delete` `fields` | `crm` |
| [Дела](/docs/entities/activities) | `/v1/activities` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Привязки дел](/docs/entities/activities/bindings) | `/v1/activities/:activityId/bindings` | `list` `bind` `unbind` `move` | `crm` |
| [Конфигурируемые дела](/docs/entities/activities/configurable) | `/v1/activity-configurable` | `create` `get` `update` | `crm` |
| [Расшифровки звонков CRM](/docs/entities/activities/transcript) | `/v1/activities/:activityId/transcript` | `get` | `crm` |
| [Товары CRM](/docs/entities/products) | `/v1/products` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Разделы товаров](/docs/entities/product-sections) | `/v1/product-sections` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Статусы и стадии](/docs/entities/statuses) | `/v1/statuses` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Валюты](/docs/entities/currencies) | `/v1/currencies` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Реквизиты](/docs/entities/requisites) | `/v1/requisites` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Шаблоны реквизитов](/docs/entities/requisite-presets) | `/v1/requisite-presets` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Банковские реквизиты](/docs/entities/bank-details) | `/v1/bank-details` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Адреса](/docs/entities/addresses) | `/v1/addresses`, `/v1/addresses/:typeId/:entityTypeId/:entityId` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Связи реквизитов](/docs/entities/requisite-links) | `/v1/requisite-links`, `/v1/requisite-links/:entityTypeId/:entityId` | `list` `get` `register` `update` `unregister` `fields` `search` | `crm` |
| [Комментарии таймлайна](/docs/entities/timelines) | `/v1/timelines` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Раскладка карточки CRM](/docs/entities/crm-card-config) | `/v1/crm/card-config/:entityTypeId` | `get` `set` `reset` `force-common` | `crm` |

### Смарт-процессы

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Смарт-процессы](/docs/entities/smart-processes) | `/v1/smart-processes` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Элементы смарт-процессов](/docs/entities/items) | `/v1/items/:entityTypeId` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |

### Задачи

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Задачи](/docs/entities/tasks) | `/v1/tasks` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `tasks` |
| [Комментарии к задачам](/docs/entities/task-comments) | `/v1/tasks/:taskId/comments` | `list` `get` `create` `update` `delete` | `task` |
| [Учёт времени задач](/docs/entities/tasks/time) | `/v1/tasks/:taskId/time` | `list` `get` `create` `update` `delete` | `task` |
| [Чат задачи](/docs/entities/tasks/chat) | `/v1/tasks/:taskId/chat/messages` | `get` | `task` |
| [История изменений задачи](/docs/task-history) | `/v1/tasks/:taskId/history` | `get` | `task` |
| [Стадии канбана задач](/docs/task-stages) | `/v1/tasks/stages/:entityId` | `get` | `task` |
| [Scrum (эпики, размещение, этапы)](/docs/scrum) | `/v1/scrum/epics`, `/v1/scrum/tasks/:taskId`, `/v1/scrum/sprints` | `list` `get` `create` `update` | `task` |

### Календарь

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [События календаря](/docs/entities/calendar-events) | `/v1/calendar-events` | `list` `get` `create` `update` `delete` `fields` `search` | `calendar` |

### Диск

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Файлы](/docs/entities/files) | `/v1/files` | `list` `get` `update` `delete` `fields` `search` `upload` `download` `moveto` `copyto` | `disk` |
| [Папки](/docs/entities/folders) | `/v1/folders` | `list` `get` `create` `update` `delete` `fields` `search` | `disk` |
| [Хранилища](/docs/entities/storages) | `/v1/storages` | `list` `get` `fields` `search` | `disk` |

### Пользователи и соцсеть

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Сотрудники](/docs/entities/users) | `/v1/users` | `list` `get` `create` `invite` `update` `delete` `fields` `search` `aggregate` | `user` |
| [Отделы](/docs/entities/departments) | `/v1/departments` | `list` `get` `create` `update` `delete` `fields` `search` | `department` |
| [Рабочие группы](/docs/entities/workgroups) | `/v1/workgroups` | `list` `get` `create` `update` `delete` `search` `fields` `aggregate` | `sonet_group` |

### Торговый каталог

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Каталоги](/docs/entities/catalogs) | `/v1/catalogs` | `list` `get` `search` `fields` | `catalog` |
| [Товары каталога](/docs/entities/catalog-products) | `/v1/catalog-products` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `catalog` |
| [Свойства товаров каталога](/docs/entities/catalog-product-properties) | `/v1/catalog-product-properties` | `list` `get` `create` `update` `delete` `search` `fields` | `catalog` |
| [Значения списочных свойств](/docs/entities/catalog-product-property-enums) | `/v1/catalog-product-property-enums` | `list` `get` `search` `fields` | `catalog` |
| [Разделы каталога](/docs/entities/catalog-sections) | `/v1/catalog-sections` | `list` `get` `create` `update` `delete` `fields` `search` | `catalog` |
| [Цены каталога](/docs/entities/catalog-prices) | `/v1/catalog-prices` | `list` `get` `create` `update` `delete` `search` `fields` | `catalog` |
| [Склады](/docs/entities/warehouses) | `/v1/warehouses` | `list` `get` `create` `update` `delete` `stock` | `catalog` |

### Интернет-магазин

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Заказы](/docs/entities/orders) | `/v1/orders` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `sale` |
| [Оплаты](/docs/entities/payments) | `/v1/payments` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `sale` |
| [Позиции корзины](/docs/entities/basket-items) | `/v1/basket-items` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `sale` |
| [Статусы заказов](/docs/entities/order-statuses) | `/v1/order-statuses` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `sale` |

### Сайты

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Сайты](/docs/entities/sites) | `/v1/sites` | `list` `get` `create` `update` `delete` `search` `fields` `aggregate` | `landing` |
| [Страницы](/docs/entities/pages) | `/v1/pages` | `list` `get` `create` `update` `delete` `search` `fields` `aggregate` | `landing` |

### Генератор документов

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Шаблоны документов](/docs/entities/doc-templates) | `/v1/doc-templates` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `documentgenerator` |
| [Документы](/docs/entities/documents) | `/v1/documents` | `list` `get` `create` `update` `delete` `fields` `search` | `documentgenerator` |
| [Документы по CRM-сущности](/docs/entities/documents/crm-list) | `/v1/crm-documents` | `list` | `crm` |

### Бронирование

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Бронирования](/docs/entities/bookings) | `/v1/bookings` | `list` `get` `create` `update` `delete` `search` `fields` | `booking` |
| [Ресурсы бронирования](/docs/entities/booking-resources) | `/v1/booking-resources` | `list` | `booking` |

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

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Шаблоны бизнес-процессов](/docs/entities/bizproc-templates) | `/v1/bizproc-templates` | `list` `create` `update` `delete` `fields` `search` | `bizproc` |
| [Действия бизнес-процессов](/docs/entities/bizproc-activities) | `/v1/bizproc-activities` | `list` `create` `update` `delete` `fields` | `bizproc` |
| [Роботы](/docs/entities/bizproc-robots) | `/v1/bizproc-robots` | `list` `create` `update` `delete` `fields` | `bizproc` |

### Открытые линии

| Сущность | Путь | Операции | Скоуп |
|----------|------|----------|-------|
| [Конфигурации открытых линий](/docs/openlines/config) | `/v1/openline-configs` | `list` `get` `create` `update` `delete` `search` `fields` `aggregate` | `imopenlines` |

## Специализированные API

Эти API имеют собственные эндпоинты, выходящие за рамки стандартного CRUD:

| API | Путь | Скоуп | Описание |
|-----|------|-------|----------|
| Боты | `/v1/bots` | `imbot` | Платформа ботов (imbot.v2): регистрация, сообщения, чаты, команды, файлы |
| Чаты | `/v1/chats` | `im` | IM Chat API: чаты CRM-сущностей, сообщения, групповые чаты |
| Бизнес-процессы | `/v1/workflows` | `bizproc` | Запуск, список, завершение процессов, события |
| [Уведомления](/docs/notifications) | `/v1/notifications` | `im` | Уведомления сотрудникам Битрикс24 |
| [Телефония](/docs/telephony) | `/v1/calls`, `/v1/telephony-lines`, `/v1/voximplant-lines` | `telephony` | Регистрация внешних звонков в CRM, исходящие звонки, линии, статистика |
| Триггеры | `/v1/triggers` | `crm` | Триггеры CRM-автоматизации: запуск триггера по сделке/лиду |
| Лог таймлайна | `/v1/timeline-logs` | `crm` | Таймлайн CRM: действия, заметки, закрепление, привязка к сущностям |
| Посты | `/v1/posts` | `log` | Живая лента: объявления, комментарии |
| Пользовательские поля | `/v1/userfields` | `crm` | Пользовательские поля CRM: сделки, лиды, контакты, компании, предложения |
| [История стадий](/docs/stage-history) | `/v1/stage-history` | `crm` | История переходов по стадиям CRM |
| [Дубликаты](/docs/duplicates) | `/v1/duplicates/find` | `crm` | Поиск дубликатов по телефону/email |
| [Scrum](/docs/scrum) | `/v1/scrum` | `task` | Эпики, скрам-размещение задач и этапы канбана: создание/переименование эпиков, привязка задачи к эпику, авто-бэклог, колонки доски спринта |
| [Чат задачи](/docs/entities/tasks/chat) | `/v1/tasks/:taskId/chat/messages` | `task` | Чтение чата задачи от новых сообщений к старым, курсорная пагинация. Ключу нужен скоуп `im` |
| [Расшифровки звонков CRM](/docs/entities/activities/transcript) | `/v1/activities/:activityId/transcript` | `crm` | Готовая AI-расшифровка звонка клиента по `activityId` дела-звонка |
| Рабочий день | `/v1/workday` | `timeman` | Учёт рабочего времени: открытие/закрытие дня, статус, настройки |
| Пакетные запросы | `/v1/batch` | `*` | До 50 вызовов сущностей в одном запросе (1 единица рейт-лимита) |

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

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

- **[Фильтрация](/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` загружает связанные сущности в одном запросе