метод REST
scope: crm
crm.userfield.fields
Получить описание для пользовательских полей
Описание
Метод crm.userfield.fields возвращает описание характеристик пользовательских полей
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.userfield.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.userfield.fields
// 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
type FieldDescriptor = {
type: string
title: string
isReadOnly?: boolean
isImmutable?: boolean
isMultiple?: boolean
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type UserfieldFieldsResult = Record<string, FieldDescriptor>
try {
const response = await $b24.actions.v2.call.make<UserfieldFieldsResult>({
method: 'crm.userfield.fields',
params: {},
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(Object.keys(result))
}
} 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 fetchUserfieldFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.userfield.fields',
params: {},
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(Object.keys(result))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchUserfieldFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.userfield.fields().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}")
try {
$response = $b24Service
->core
->call(
'crm.userfield.fields',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching CRM userfield fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.userfield.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.userfield.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.userfield.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.userfield.fields: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))
Ответ
HTTP-статус: 200
{
"result": {
"ID": {
"type": "int",
"title": "Ид",
"isReadOnly": true
},
"ENTITY_ID": {
"type": "string",
"title": "Объект",
"isImmutable": true
},
"FIELD_NAME": {
"type": "string",
"title": "Код",
"isImmutable": true
},
"USER_TYPE_ID": {
"type": "string",
"title": "Тип данных",
"isImmutable": true
},
"XML_ID": {
"type": "string",
"title": "Внешний Ид (XML ID)"
},
"SORT": {
"type": "int",
"title": "Сортировка"
},
"MULTIPLE": {
"type": "char",
"title": "Множественное"
},
"MANDATORY": {
"type": "char",
"title": "Обязательное"
},
"SHOW_FILTER": {
"type": "char",
"title": "Показывать в фильтре списка"
},
"SHOW_IN_LIST": {
"type": "char",
"title": "Показывать в списке"
},
"EDIT_IN_LIST": {
"type": "char",
"title": "Разрешать редактирование пользователем"
},
"IS_SEARCHABLE": {
"type": "char",
"title": "Значения поля участвуют в поиске"
},
"EDIT_FORM_LABEL": {
"type": "string",
"title": "Подпись в форме редактирования"
},
"LIST_COLUMN_LABEL": {
"type": "string",
"title": "Заголовок в списке"
},
"LIST_FILTER_LABEL": {
"type": "string",
"title": "Подпись фильтра в списке"
},
"ERROR_MESSAGE": {
"type": "string",
"title": "Сообщение об ошибке"
},
"HELP_MESSAGE": {
"type": "string",
"title": "Помощь"
},
"LIST": {
"type": "uf_enum_element",
"title": "Элементы списка",
"isMultiple": true
},
"SETTINGS": {
"type": "object",
"title": "Дополнительные настройки (зависят от типа)"
}
},
"time": {
"start": 1773992295,
"finish": 1773992295.958088,
"duration": 0.9580879211425781,
"processing": 0,
"date_start": "2026-03-20T10:38:15+03:00",
"date_finish": "2026-03-20T10:38:15+03:00",
"operating_reset_at": 1773992895,
"operating": 0
}
}
Возвращаемые данные
result
object
Объект с описанием характеристик (подробное описание)
time
time
Информация о времени выполнения запроса

