b24_crm_fields
Read-onlyIdempotent
Retrieve all fields for a CRM entity, including custom user fields, to ensure correct field codes and enum IDs before creating or updating records.
Instructions
Describe an entity's fields, including user fields (UF_*).
Essential before add/update so you use correct field codes and enum ids.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity | No | Classic CRM entity: 'lead', 'deal', 'contact', 'company', or 'quote'. Ignored when entity_type_id is set. | deal |
| 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 |