b24_crm_list
Read-onlyIdempotent
Retrieve CRM records with filtering, sorting, and pagination. Supports classic entities (deal, lead, etc.) and modern SPAs, returning paginated JSON with item count and next offset.
Instructions
List CRM records with filtering, sorting, and pagination.
Args: entity: classic entity name (default 'deal'). entity_type_id: set to use crm.item.list for SPA/modern objects. filter/select/order/start/fetch_all: standard list controls.
Returns: JSON pagination envelope {items, count, total, next, has_more, truncated}.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order | No | Sort object, e.g. {'ID':'DESC'} or {'DATE_CREATE':'ASC'}. | |
| start | No | Pagination offset (page size is 50). Use 'next' from a prior response. | |
| entity | No | Classic CRM entity: 'lead', 'deal', 'contact', 'company', or 'quote'. Ignored when entity_type_id is set. | deal |
| filter | No | Bitrix filter object. Keys may carry operator prefixes: '>', '<', '>=', '<=', '!', '%' (substring), '=%', e.g. {">=DATE_CREATE": "2026-01-01", "%TITLE": "draft"}. | |
| select | No | Fields to return, e.g. ['ID','TITLE','*','UF_*']. Omit for defaults. | |
| fetch_all | No | Auto-paginate and return all matching records (capped by BITRIX_MAX_PAGES, default 40 pages = 2000 records). Use a filter to keep this bounded. | |
| webhook_url | No | Override the default incoming webhook for this call (https://<portal>/rest/<user_id>/<token>/). If omitted, uses personal_webhook, then the X-B24-Webhook HTTP header, then the BITRIX_WEBHOOK_URL env default. | |
| entity_type_id | No | Numeric CRM entity type id for the modern crm.item.* API (e.g. 1=lead, 2=deal, 1030+=Smart Process). Set this to work with SPA items. | |
| personal_webhook | No | Act as a specific user (their personal incoming webhook). Takes precedence over webhook_url. Required to write to the portal under that user's permissions. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |