#Справочник сущностей
Полный перечень сущностей и специализированных 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/activities |
list get create update delete fields search aggregate |
crm |
| Товары CRM |
/v1/products |
list get create update delete fields search aggregate |
crm |
| Разделы товаров |
/v1/product-sections |
list get create update delete fields search aggregate |
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/timelines |
list get create update delete fields search aggregate |
crm |
#Смарт-процессы
| Сущность |
Путь |
Операции |
Скоуп |
| Смарт-процессы |
/v1/smart-processes |
list get search aggregate |
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 |
tasks |
#Календарь
| Сущность |
Путь |
Операции |
Скоуп |
| События календаря |
/v1/calendar-events |
list get create update delete search aggregate |
calendar |
#Диск
| Сущность |
Путь |
Операции |
Скоуп |
| Файлы |
/v1/files |
list get update delete fields search aggregate |
disk |
| Папки |
/v1/folders |
list get create update delete fields search aggregate |
disk |
| Хранилища |
/v1/storages |
list get fields search aggregate |
disk |
#Пользователи и соцсеть
| Сущность |
Путь |
Операции |
Скоуп |
| Пользователи |
/v1/users |
list get create update fields search aggregate |
user |
| Отделы |
/v1/departments |
list get create update delete search aggregate |
department |
| Рабочие группы |
/v1/workgroups |
list get create update delete search aggregate |
sonet_group |
#Торговый каталог
| Сущность |
Путь |
Операции |
Скоуп |
| Товары каталога |
/v1/catalog-products |
list get create update delete fields search aggregate |
catalog |
| Разделы каталога |
/v1/catalog-sections |
list get create update delete search aggregate |
catalog |
| Цены каталога |
/v1/catalog-prices |
list get create update delete search aggregate |
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 aggregate |
landing |
| Страницы |
/v1/pages |
list get create update delete search aggregate |
landing |
#Генератор документов
| Сущность |
Путь |
Операции |
Скоуп |
| Шаблоны документов |
/v1/doc-templates |
list get create update delete fields search aggregate |
documentgenerator |
| Документы |
/v1/documents |
list get create update delete fields search aggregate |
documentgenerator |
#Бронирование
| Сущность |
Путь |
Операции |
Скоуп |
| Бронирования |
/v1/bookings |
list get create update delete search aggregate |
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 aggregate |
imopenlines |
#Телефония
| Сущность |
Путь |
Операции |
Скоуп |
| Линии телефонии |
/v1/telephony-lines |
list create update delete search aggregate |
telephony |
#Специализированные API
Эти API имеют собственные эндпоинты, выходящие за рамки стандартного CRUD:
| API |
Путь |
Скоуп |
Описание |
| Боты |
/v1/bots |
imbot |
Платформа ботов (imbot.v2): регистрация, сообщения, чаты, команды, файлы |
| Чаты |
/v1/chats |
im |
IM Chat API: чаты CRM-сущностей, сообщения, групповые чаты |
| Бизнес-процессы |
/v1/workflows |
bizproc |
Запуск, список, завершение процессов, события |
| Уведомления |
/v1/notifications |
im |
Push-уведомления пользователям Битрикс24 |
| Звонки |
/v1/calls |
telephony |
Внешние звонки, автодозвон с TTS, обратные звонки, статистика |
| Триггеры |
/v1/triggers |
crm |
Триггеры CRM-автоматизации: запуск триггера по сделке/лиду |
| Лог таймлайна |
/v1/timeline-logs |
crm |
Таймлайн CRM: действия, заметки, закрепление, привязка к сущностям |
| Склады |
/v1/warehouses |
catalog |
Склады и остатки товаров |
| Посты |
/v1/posts |
log |
Живая лента: объявления, комментарии |
| Пользовательские поля |
/v1/userfields |
crm |
Пользовательские поля CRM: сделки, лиды, контакты, компании, предложения |
| История стадий |
/v1/stage-history |
crm |
История переходов по стадиям CRM |
| Дубликаты |
/v1/duplicates |
crm |
Поиск дубликатов по телефону/email |
| Время задач |
/v1/tasks/:taskId/time |
task |
Трекинг времени: список, добавление, обновление, удаление записей |
| Рабочий день |
/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 загружает связанные сущности в одном запросе