For AI agents: markdown of this page — /docs-content-en/entities/crm-search/search.md documentation index — /llms.txt

Search CRM records

POST /v1/crm/search calls crm.entity.search:

JSON

{"searchQuery":"Acme","options":{"types":["CONTACT","COMPANY"],"scope":"DENOMINATION"}}

searchQuery is required. Omit types to search all supported types. The accepted names are LEAD, DEAL, CONTACT, COMPANY, INVOICE, QUOTE and SMART_INVOICE; portal smart process IDs are also accepted. An unknown type returns 400 before the search. categoryId narrows categories where applicable.

DENOMINATION searches names; INDEX searches the full text index, including phone and email. The result contains data: [{id, type, entityTypeId, title, subTitle, links: {show}, attributes: {phone?, email?}}] and meta: {limit:20, limits, limitsMeaning}. links.show is a relative UI path. attributes.phone/email contain {type, value} pairs; other Bitrix24 attributes and actions are omitted.

Bitrix24 refusals return 422; missing scope returns 403. When meta.limits is nonempty, some types were omitted by the Bitrix24 tariff limit.