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

Entity fields

GET /v1/crm-forms/entity-fields

Bitrix24 method: crm.form.entityfield.list (REST v3).

Scope: crm. READONLY keys are supported.

Behavior and parameters

entityName is required. Pass one entity name, repeated values, entityName[], or a comma-separated list of up to ten names. Multiple names use the v3 in filter. Missing names return 400 MISSING_REQUIRED_FIELDS; more than ten names return 400 INVALID_PARAMS before Bitrix24. The result contains names, labels, types, required/multiple flags, entity names and option items.

Examples

Terminal 
curl 'https://vibecode.bitrix24.com/v1/crm-forms/entity-fields?entityName=LEAD' \
  -H 'X-Api-Key: YOUR_API_KEY'
javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/crm-forms/entity-fields?entityName=LEAD', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await response.json()

For an OAuth application, use its key and add Authorization: Bearer USER_SESSION_TOKEN.

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue
Fielddata Typearray DescriptionResult

Errors

HTTP Code Meaning
HTTP400 CodeINVALID_PARAMS MeaningMalformed query or id
HTTP400 CodeUNKNOWN_FILTER_FIELD MeaningUnknown query parameter or filter
HTTP401 CodeMISSING_API_KEY / TOKEN_MISSING MeaningMissing key or Bitrix24 credentials
HTTP403 CodeSCOPE_DENIED MeaningThe key lacks crm
HTTP403 CodeBITRIX_ACCESS_DENIED / CRM_FORM_* MeaningBitrix24 refused access
HTTP404 CodeENTITY_NOT_FOUND MeaningBitrix24 did not find the record
HTTP409 CodeCRM_FORM_* MeaningBitrix24 domain refusal; code and message preserved
HTTP422 CodeBITRIX_ERROR MeaningOther Bitrix24 refusal; message and b24Code retained
HTTP429 CodeRATE_LIMITED MeaningBitrix24 rate limit
HTTP502 CodeBITRIX_UNAVAILABLE MeaningUnavailable or malformed Bitrix24 response
HTTP503 CodeBITRIX_TIMEOUT MeaningBitrix24 timeout

Common API errors.

See also