Получить список полей CRM-формы crm.form.field.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом на просмотр CRM-форм
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод crm.form.field.list возвращает список доступных полей CRM-формы.
Параметры метода
|
Название |
Описание |
|
select |
Список полей описания, которые нужно вернуть в ответе. Доступные поля:
По умолчанию возвращаются все поля описания |
Признак editable в ответе для всех полей равен false. Какие поля можно записать в crm.form.add и crm.form.update, описано в разделе Структура CRM-формы. Кроме полей из ответа, в фильтре crm.form.list можно использовать crm.entityScheme и responsible.userIds.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.form.field.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","filterable","sortable"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.field.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","filterable","sortable"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.field.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type FormFieldListResult = {
items: Array<{
name?: string
type?: string
filterable?: boolean
sortable?: boolean
}>
}
try {
const response = await $b24.actions.v3.call.make<FormFieldListResult>({
method: 'crm.form.field.list',
params: {
select: ['name', 'type', 'filterable', 'sortable'],
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.items)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listFormFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'crm.form.field.list',
params: {
select: ['name', 'type', 'filterable', 'sortable'],
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.items)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listFormFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
# client = Client(token, prefer_version=3)
try:
bitrix_response = client.crm.form.field.list(
select=["name", "type", "filterable", "sortable"],
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'crm.form.field.list',
[
'select' => ['name', 'type', 'filterable', 'sortable'],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'crm.form.field.list',
{
select: ['name', 'type', 'filterable', 'sortable'],
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'crm.form.field.list',
[
'select' => ['name', 'type', 'filterable', 'sortable'],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы, базовый адрес клиента содержит /rest/api/
res, err := client.Core().Call(ctx, "crm.form.field.list", b24.Params{
"select": []string{"name", "type", "filterable", "sortable"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.form.field.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "items".
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
return fmt.Errorf("в ответе нет ключа items")
}
var fields []struct {
Name string `json:"name"`
Type string `json:"type"`
Filterable bool `json:"filterable"`
Sortable bool `json:"sortable"`
}
if err := json.Unmarshal(raw, &fields); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(len(fields))
Обработка ответа
HTTP-статус: 200
{
"result": {
"items": [
{
"name": "id",
"type": "int",
"filterable": true,
"sortable": true
},
{
"name": "code",
"type": "string",
"filterable": true,
"sortable": false
},
{
"name": "name",
"type": "string",
"filterable": true,
"sortable": true
},
{
"name": "crm",
"type": "object",
"filterable": false,
"sortable": false
},
{
"name": "fields",
"type": "object",
"filterable": false,
"sortable": false
}
]
},
"time": {
"start": 1792594654,
"finish": 1792594654.4475,
"duration": 0.44749999046325684,
"processing": 0,
"date_start": "2026-10-21T17:57:34+03:00",
"date_finish": "2026-10-21T17:57:34+03:00",
"operating_reset_at": 1792595220,
"operating": 0
}
}
Ответ сокращен: метод возвращает все 25 полей формы — id, code, name, active, system, languageId, templateId, createdTime, updatedTime, activeChangedById, activeChangedTime, appearance, crm, dependencies, presetFields, responsible, agreements, submission, payment, callback, booking, analytics, spamProtection, integrations, fields.
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
items |
Массив описаний полей. Структура элемента зависит от |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION",
"message": "Не удается распознать выражение select `abc`"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте, что у пользователя есть право на просмотр CRM-форм |
Ошибки в параметре select
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
HTTP-статус: 400
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте только поля из списка: |
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
HTTP-статус: 400
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение select |
Передайте |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |