Get Description for Custom Fields crm.userfield.fields
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: any user
The method crm.userfield.fields returns a description of the characteristics of custom fields.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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 and ctx are already created — see the Go SDK section
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("expected an object in the response")
}
fmt.Println("fields in response:", len(keys))
Response Handling
HTTP status: 200
{
"result": {
"ID": {
"type": "int",
"title": "ID",
"isReadOnly": true
},
"ENTITY_ID": {
"type": "string",
"title": "Object",
"isImmutable": true
},
"FIELD_NAME": {
"type": "string",
"title": "Code",
"isImmutable": true
},
"USER_TYPE_ID": {
"type": "string",
"title": "Data Type",
"isImmutable": true
},
"XML_ID": {
"type": "string",
"title": "External ID (XML ID)"
},
"SORT": {
"type": "int",
"title": "Sorting"
},
"MULTIPLE": {
"type": "char",
"title": "Multiple"
},
"MANDATORY": {
"type": "char",
"title": "Mandatory"
},
"SHOW_FILTER": {
"type": "char",
"title": "Show in list filter"
},
"SHOW_IN_LIST": {
"type": "char",
"title": "Show in list"
},
"EDIT_IN_LIST": {
"type": "char",
"title": "Allow user editing"
},
"IS_SEARCHABLE": {
"type": "char",
"title": "Field values are searchable"
},
"EDIT_FORM_LABEL": {
"type": "string",
"title": "Label in edit form"
},
"LIST_COLUMN_LABEL": {
"type": "string",
"title": "Header in list"
},
"LIST_FILTER_LABEL": {
"type": "string",
"title": "Filter label in list"
},
"ERROR_MESSAGE": {
"type": "string",
"title": "Error message"
},
"HELP_MESSAGE": {
"type": "string",
"title": "Help"
},
"LIST": {
"type": "uf_enum_element",
"title": "List elements",
"isMultiple": true
},
"SETTINGS": {
"type": "object",
"title": "Additional settings (dependent on type)"
}
},
"time": {
"start": 1773992295,
"finish": 1773992295.958088,
"duration": 0.9580879211425781,
"processing": 0,
"date_start": "2026-03-20T10:38:15+02:00",
"date_finish": "2026-03-20T10:38:15+02:00",
"operating_reset_at": 1773992895,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with a description of characteristics (detailed description) |
|
time |
Information about the request execution time |
Fields of the result object
|
Name |
Description |
|
ID |
Identifier |
|
ENTITY_ID |
Custom field object |
|
FIELD_NAME |
Field code |
|
USER_TYPE_ID |
Custom field data type |
|
XML_ID |
External ID (XML ID) |
|
SORT |
Sorting order |
|
MULTIPLE |
Multiple indicator |
|
MANDATORY |
Mandatory indicator |
|
SHOW_FILTER |
Display in list filter indicator |
|
SHOW_IN_LIST |
Display in list indicator |
|
EDIT_IN_LIST |
Allow user editing indicator |
|
IS_SEARCHABLE |
Field values are searchable indicator |
|
Label in edit form |
|
|
Header in list |
|
|
Filter label in list |
|
|
Error message |
|
|
Help |
|
|
LIST |
List elements for |
|
SETTINGS |
Additional settings depending on field type |
Error Handling
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |