## Список полей сущностей

`GET /v1/crm-forms/entity-fields`

Возвращает поля лидов, контактов, компаний, сделок и других сущностей CRM, которые можно добавить в CRM-форму. Вызывайте перед созданием или изменением формы, чтобы узнать имена полей.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `entityName` (query) | string | да | Имя сущности CRM, например `LEAD`, `CONTACT`, `COMPANY`, `DEAL`, `DYNAMIC_177`. Список: `data.entitySchemes[].entityNames` в [Конфигурация конструктора](/docs/entities/crm-forms/configuration).<br>Несколько сущностей — до 10 имён одним из способов: через запятую `?entityName=LEAD,CONTACT`, повтором `?entityName=LEAD&entityName=CONTACT` или `?entityName[]=LEAD&entityName[]=CONTACT` |

Других параметров строки запроса эндпоинт не принимает.

## Примеры

### curl — личный ключ

```bash
curl "https://vibecode.bitrix24.tech/v1/crm-forms/entity-fields?entityName=LEAD" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl "https://vibecode.bitrix24.tech/v1/crm-forms/entity-fields?entityName=LEAD" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/entity-fields?entityName=LEAD', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(data.map(field => `${field.name} — ${field.label}`))
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/entity-fields?entityName=LEAD', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Поля всех запрошенных сущностей одним массивом. Постраничной выдачи нет |
| `data[].name` | string | Имя поля в форме: имя сущности и код поля, например `LEAD_NAME`. Это значение передаётся в `fields[].name` при [создании формы](/docs/entities/crm-forms/create) |
| `data[].label` | string | Название поля |
| `data[].type` | string | Тип поля: `string`, `text`, `list`, `date`, `datetime`, `double`, `file`, `typed_string`, `crm_entity`, `resourcebooking`. Тип `typed_string` — у полей связи: телефона, электронной почты, сайта, мессенджера |
| `data[].required` | boolean | Обязательно ли поле |
| `data[].multiple` | boolean | Принимает ли поле несколько значений |
| `data[].entityName` | string | Сущность, которой принадлежит поле, например `LEAD` |
| `data[].entityLabel` | string | Название сущности |
| `data[].items` | array | Варианты значения поля типа `list`. У полей других типов — пустой массив |
| `data[].items[].id` | string | Идентификатор варианта, например `WEB` у поля `LEAD_SOURCE_ID` |
| `data[].items[].label` | string | Название варианта |

## Пример ответа

Показаны четыре поля из ответа по лиду. Идентификаторы вариантов зависят от портала; подписи в примере условные:

```json
{
  "success": true,
  "data": [
    {
      "name": "LEAD_TITLE",
      "label": "Название лида",
      "type": "string",
      "required": false,
      "multiple": false,
      "entityName": "LEAD",
      "entityLabel": "Лид",
      "items": []
    },
    {
      "name": "LEAD_HONORIFIC",
      "label": "Обращение",
      "type": "list",
      "required": false,
      "multiple": false,
      "entityName": "LEAD",
      "entityLabel": "Лид",
      "items": [
        {
          "id": "HNR_RU_1",
          "label": "г-н"
        },
        {
          "id": "HNR_RU_2",
          "label": "г-жа"
        }
      ]
    },
    {
      "name": "LEAD_NAME",
      "label": "Имя",
      "type": "string",
      "required": false,
      "multiple": false,
      "entityName": "LEAD",
      "entityLabel": "Лид",
      "items": []
    },
    {
      "name": "LEAD_PHONE",
      "label": "Телефон",
      "type": "typed_string",
      "required": false,
      "multiple": true,
      "entityName": "LEAD",
      "entityLabel": "Лид",
      "items": []
    }
  ]
}
```

## Пример ответа при ошибке

400 — не передан `entityName`:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "entityName is required"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `MISSING_REQUIRED_FIELDS` | Не передан `entityName` |
| 400 | `INVALID_PARAMS` | Больше 10 имён, пустое имя или неизвестный параметр запроса |
| 403 | `BITRIX_ACCESS_DENIED` | У пользователя Битрикс24 нет прав на формы |
| 403 | `BITRIX_INSUFFICIENT_SCOPE` | У токена Битрикс24 нет необходимого скоупа |
| 404 | `ENTITY_NOT_FOUND` | Портал не нашёл запрошенную сущность или описание поля. Исходный код — `error.b24Code` |
| 409 | `CRM_FORM_REST_NOT_ENABLED` | REST-методы CRM-форм недоступны на этом портале Битрикс24. Это не означает отсутствие отдельной формы |
| 400–599 | `CRM_FORM_*` | Отказ по правилам форм. Код и HTTP-статус сохранены, исходный код — в `error.b24Code` |
| 422 | `BITRIX_ERROR` | Другой отказ Битрикс24. Причина — в `error.message`, исходный код — в `error.b24Code` |
| 429 | `RATE_LIMITED` | Превышена частота запросов. Учитывайте заголовок `Retry-After` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 вернул ответ в неожиданном виде |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен: ошибка сервера или разрыв соединения |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил вовремя. Чтение можно повторить |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | У ключа не настроен доступ к Битрикс24 |
| 403 | `SCOPE_DENIED` | У API-ключа Вайбкод нет скоупа `crm` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Смотрите также

- [Получить конфигурацию конструктора](/docs/entities/crm-forms/configuration)
- [Поля контракта формы](/docs/entities/crm-forms/fields)
- [Создать форму](/docs/entities/crm-forms/create)
- [Изменить форму](/docs/entities/crm-forms/update)
- [CRM-формы](/docs/entities/crm-forms)