Методы CRM предыдущей версии API: обзор

Методы предыдущей версии API вызываются по адресу /rest/ и сохранены для поддержки существующих интеграций. Для новой разработки предназначены методы CRM в REST 3.0, они описаны в обзоре CRM. Методы обеих версий можно вызывать из одной интеграции.

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Быстрый переход: все разделы и методы

Универсальные методы и методы объектов

В предыдущей версии с элементами CRM работают два набора методов:

  • универсальные методы crm.item.* — одни методы для всех типов, тип объекта передается в параметре entityTypeId. Имена полей пишутся в camelCase, например assignedById
  • методы объектов crm.deal.*, crm.lead.*, crm.contact.*, crm.company.*, crm.quote.* — отдельный набор для каждого типа. Имена полей пишутся в верхнем регистре, например ASSIGNED_BY_ID

Типы смарт-процессов создают и настраивают методы crm.type.*. Их аналогов в REST 3.0 нет, поэтому они нужны и интеграциям на REST 3.0.

Аналоги методов в REST 3.0, их ограничения и отличия версий описаны на странице Переход на новые методы CRM.

Обзор разделов и методов

Scope: crm

Кто может выполнять метод: в зависимости от метода

Справочные материалы

Статья

Описание

Типы данных и структура объектов в REST API CRM

Что такое entityTypeId, какие бывают идентификаторы и как устроены объекты CRM

Поля основных объектов CRM

Поля ключевых объектов CRM в одном месте

Ограничения длины полей CRM

Максимальная длина стандартных полей CRM и способ получить лимиты пользовательских полей

Объекты CRM

Раздел

Когда использовать

Ключевые методы

Универсальные методы CRM

Для работы с объектами CRM и смарт-процессами через entityTypeId

crm.item.add, crm.item.update, crm.item.list

Все методы раздела

Сделки

Для работы со сделками, их карточками и связями с контактами

crm.deal.add, crm.deal.update, crm.deal.list

Все методы раздела

Лиды

Для работы с лидами, их карточками и связями с контактами

crm.lead.add, crm.lead.update, crm.lead.list

Все методы раздела

Контакты

Для работы с контактами, их карточками и связями с компаниями

crm.contact.add, crm.contact.update, crm.contact.list

Все методы раздела

Компании

Для работы с компаниями, их карточками и связями с контактами

crm.company.add, crm.company.update, crm.company.list

Все методы раздела

Коммерческие предложения

Для работы с коммерческими предложениями и товарными позициями

crm.quote.add, crm.quote.update, crm.quote.list

Все методы раздела

Настройки и справочники

Раздел

Когда использовать

Ключевые методы

Реквизиты

Для работы с реквизитами, адресами и банковскими данными CRM

crm.requisite.add, crm.requisite.update, crm.requisite.list

Все методы раздела

Справочники

Для управления системными списками CRM: стадиями, источниками, типами

crm.status.add, crm.status.update, crm.status.list

Все методы раздела

Вспомогательные объекты

Для работы с перечислениями, множественными полями и другими служебными объектами CRM

crm.enum.ownertype

Все методы раздела

Отдельные методы

Метод

Описание

crm.settings.mode.get

Возвращает текущий режим работы CRM
Предыдущая
Получить историю движения по стадиям
Следующая
Обзор