Справочник сущностей

Полный перечень сущностей и специализированных API с доступными операциями. Для каждой сущности указан путь, набор операций и требуемый скоуп. Описание общего формата запросов и ответов — в разделе Обзор API.

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

CRM

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

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

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

Задачи

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

Календарь

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

Диск

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

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

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

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

Сущность	Путь	Операции	Скоуп
Каталоги	`/v1/catalogs`	`list` `get` `search` `fields`	`catalog`
Товары каталога	`/v1/catalog-products`	`list` `get` `create` `update` `delete` `fields` `search` `aggregate`	`catalog`
Свойства товаров каталога	`/v1/catalog-product-properties`	`list` `get` `create` `update` `delete` `search` `fields`	`catalog`
Разделы каталога	`/v1/catalog-sections`	`list` `get` `create` `update` `delete` `search` `aggregate`	`catalog`
Цены каталога	`/v1/catalog-prices`	`list` `get` `create` `update` `delete` `search` `fields`	`catalog`
Склады	`/v1/warehouses`	`list` `get` `create` `update` `delete` `stock`	`catalog`

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

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

Сайты

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

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

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

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

Сущность	Путь	Операции	Скоуп
Бронирования	`/v1/bookings`	`list` `get` `create` `update` `delete` `search` `fields`	`booking`

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

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

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

Сущность	Путь	Операции	Скоуп
Конфигурации открытых линий	`/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`	Запуск, список, завершение процессов, события
Уведомления	`/v1/notifications`	`im`	Уведомления сотрудникам Битрикс24
Телефония	`/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: сделки, лиды, контакты, компании, предложения
История стадий	`/v1/stage-history`	`crm`	История переходов по стадиям CRM
Дубликаты	`/v1/duplicates/find`	`crm`	Поиск дубликатов по телефону/email
Scrum	`/v1/scrum`	`task`	Эпики и скрам-размещение задач: создание/переименование эпиков, привязка задачи к эпику, авто-бэклог
Чат задачи	`/v1/tasks/:taskId/chat/messages`	`task`	Чтение чата задачи (newest-first, курсорная пагинация); ключу нужен B24-скоуп `im`
Расшифровки звонков CRM	`/v1/activities/:activityId/transcript`	`crm`	Готовая AI-расшифровка звонка клиента по `activityId` дела-звонка
Рабочий день	`/v1/workday`	`timeman`	Учёт рабочего времени: открытие/закрытие дня, статус, настройки
Пакетные запросы	`/v1/batch`	`*`	До 50 вызовов сущностей в одном запросе (1 единица рейт-лимита)

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

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

Фильтрация: ?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): ?include=company,contact загружает связанные сущности в одном запросе

#Справочник сущностей

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

#CRM

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

#Задачи

#Календарь

#Диск

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

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

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

#Сайты

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

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

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

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

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

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