Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-search/search.md индекс документации — /llms.txt

Найти записи CRM

POST /v1/crm/search вызывает crm.entity.search. Тело:

JSON

{"searchQuery":"Иванов","options":{"types":["CONTACT","COMPANY"],"scope":"DENOMINATION"}}

searchQuery обязателен. types можно опустить для поиска по всем поддерживаемым типам. Поддерживаются LEAD, DEAL, CONTACT, COMPANY, INVOICE, QUOTE, SMART_INVOICE и числовые ID смарт-процессов портала. Неизвестный тип возвращает 400 до поиска. categoryId выбирает категорию, где она применима.

scope: DENOMINATION ищет название или ФИО; INDEX — полнотекстовый индекс, включая телефон и email. Ответ: data: [{id, type, entityTypeId, title, subTitle, links: {show}, attributes: {phone?, email?}}], meta: {limit:20, limits, limitsMeaning}. links.show — относительный путь интерфейса, не ссылка для вызова REST. attributes.phone/email содержат пары {type, value}; другие атрибуты и actions Битрикс24 не передаются.

Если Битрикс24 отклоняет запрос, API передаёт отказ как 422. Нет scope — 403. Тарифный предел части типов отражён в meta.limits, остальные результаты доступны.