Get a list of custom fields user.userfield.list
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:
user.userfieldWho can execute the method: administrator
The user.userfield.list method retrieves a list of custom fields by filter.
Method Parameters
|
Name |
Description |
|
order |
Sorting of selected custom fields in Possible values for
Possible values for
|
|
filter |
Filter of selected custom fields in Possible values for A key can be assigned an additional prefix to specify the filter behavior. Possible prefix values:
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"id":"desc"},"filter":{"id":13}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.userfield.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"id":"desc"},"filter":{"id":13},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/user.userfield.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 each user field returned in result[]
type UserUserfieldItem = {
ID: string
ENTITY_ID: string
FIELD_NAME: string
USER_TYPE_ID: string
XML_ID: string | null
SORT: string
MULTIPLE: 'Y' | 'N'
MANDATORY: 'Y' | 'N'
SHOW_FILTER: string
SHOW_IN_LIST: 'Y' | 'N'
EDIT_IN_LIST: 'Y' | 'N'
IS_SEARCHABLE: 'Y' | 'N'
SETTINGS: Record<string, unknown>
LIST?: Array<{ ID: string; SORT: string; VALUE: string; DEF: 'Y' | 'N'; XML_ID: string }>
}
try {
const response = await $b24.actions.v2.call.make<UserUserfieldItem[]>({
method: 'user.userfield.list',
params: {
order: { id: 'desc' },
filter: { id: 13 },
},
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('Loaded user fields:', result.length, 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 listUserUserfields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'user.userfield.list',
params: {
order: { id: 'desc' },
filter: { id: 13 },
},
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('Loaded user fields:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listUserUserfields)
</script>
Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
order = {
"ID": "desc",
"SORT": "asc",
}
filter = {
"USER_TYPE_ID": "string",
"SHOW_IN_LIST": "Y",
}
try:
bitrix_response = client.user.userfield.list(
order=order,
filter=filter,
).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("Bitrix SDK error", error.message, sep="\n")
except Exception as error:
print("Unexpected error", error, sep="\n")
Example as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
order = {
"ID": "desc",
}
filter = {
"SHOW_IN_LIST": "Y",
}
try:
bitrix_response = client.user.userfield.list(
order=order,
filter=filter,
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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("Bitrix SDK error", error.message, sep="\n")
except Exception as error:
print("Unexpected error", error, sep="\n")
Example as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
order = {
"ID": "desc",
}
filter = {
"SHOW_IN_LIST": "Y",
}
try:
bitrix_response = client.user.userfield.list(
order=order,
filter=filter,
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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("Bitrix SDK error", error.message, sep="\n")
except Exception as error:
print("Unexpected error", error, sep="\n")
try {
$response = $b24Service
->core
->call(
'user.userfield.list',
[
'order' => [
'id' => 'desc',
],
'filter' => [
'id' => 13
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// The data processing logic you need
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching user fields: ' . $e->getMessage();
}
BX24.callMethod(
"user.userfield.list",
{
order: {
id: 'desc',
},
filter: {
id: 13
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'user.userfield.list',
[
'order' => [
'id' => 'desc',
],
'filter' => [
'id' => 13,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "user.userfield.list", b24.Params{
"order": b24.Params{
"id": "desc",
},
"filter": b24.Params{
"id": 13,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("user.userfield.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
EntityID string `json:"ENTITY_ID"`
FieldName string `json:"FIELD_NAME"`
UserTypeID string `json:"USER_TYPE_ID"`
Sort string `json:"SORT"`
Multiple string `json:"MULTIPLE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.EntityID)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP status: 200
{
"result":[
{
"ID":"176",
"ENTITY_ID":"USER",
"FIELD_NAME":"UF_USR_1724228142162",
"USER_TYPE_ID":"enumeration",
"XML_ID":null,
"SORT":"100",
"MULTIPLE":"Y",
"MANDATORY":"N",
"SHOW_FILTER":"E",
"SHOW_IN_LIST":"Y",
"EDIT_IN_LIST":"Y",
"IS_SEARCHABLE":"N",
"SETTINGS":{
"DISPLAY":"UI",
"LIST_HEIGHT":1,
"CAPTION_NO_VALUE":"",
"SHOW_NO_VALUE":"Y"
},
"LIST":[
{
"ID":"26",
"SORT":"0",
"VALUE":"1",
"DEF":"N",
"XML_ID":"2a53ce08b86a6aba152b1b19204fdef2"
},
{
"ID":"27",
"SORT":"100",
"VALUE":"2",
"DEF":"N",
"XML_ID":"292df2be1171ed6ab038996deac29ac8"
},
{
"ID":"28",
"SORT":"200",
"VALUE":"3",
"DEF":"N",
"XML_ID":"3c5af70eafbba79a6cf52e299ed75123"
}
]
},
{
"ID":"177",
"ENTITY_ID":"USER",
"FIELD_NAME":"UF_USR_MONEY",
"USER_TYPE_ID":"money",
"XML_ID":null,
"SORT":"100",
"MULTIPLE":"N",
"MANDATORY":"N",
"SHOW_FILTER":"N",
"SHOW_IN_LIST":"Y",
"EDIT_IN_LIST":"Y",
"IS_SEARCHABLE":"N",
"SETTINGS":{
"DEFAULT_VALUE":""
}
}
],
"total":2,
"time":{
"start":1747313326.788124,
"finish":1747313328.641663,
"duration":1.853538990020752,
"processing":0.011211156845092773,
"date_start":"2025-05-15T14:48:46+02:00",
"date_finish":"2025-05-15T14:48:48+02:00",
"operating":0
}
}
Returned Data
|
Name |
Description |
|
result |
An array of objects describing custom fields |
|
total |
Total number of records found |
|
time |
Query execution time information |
Result Object Fields
|
Name |
Description |
|
ID |
Custom field identifier |
|
ENTITY_ID |
Identifier of the object to which the field belongs. For employee custom fields, |
|
FIELD_NAME |
Custom field code |
|
USER_TYPE_ID |
Custom field type |
|
External custom field identifier |
|
|
SORT |
Sorting index |
|
MULTIPLE |
Indicates a multiple-value field. Possible values: |
|
MANDATORY |
Indicates a required field. Possible values: |
|
SHOW_FILTER |
Field display mode in the user list filter |
|
SHOW_IN_LIST |
Indicates whether the field is displayed in the user list. Possible values: |
|
EDIT_IN_LIST |
Indicates whether the field can be edited in the user list. Possible values: |
|
IS_SEARCHABLE |
Indicates whether field values are included in search. Possible values: |
|
EDIT_FORM_LABEL |
Field label in the edit form |
|
LIST_COLUMN_LABEL |
Field header in the user list |
|
LIST_FILTER_LABEL |
Field label in the user list filter |
|
ERROR_MESSAGE |
Error message shown when validating the field value |
|
HELP_MESSAGE |
Field hint |
|
USER_TYPE_OWNER |
Identifier of the application that owns the custom field type. Returned for types registered by applications |
|
SETTINGS |
Custom field settings. The set of fields depends on |
|
LIST |
List items. Returned when |
LIST Item Fields
|
Name |
Description |
|
ID |
List item identifier |
|
SORT |
Sorting index |
|
VALUE |
List item value |
|
DEF |
Indicates the default value. Possible values: |
|
XML_ID |
External list item identifier |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Access denied."
}
|
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 |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
Empty string |
Access denied. |
Not enough permissions to retrieve the list of custom fields |
|
|
|
The request requires higher privileges than provided by the webhook token |
The webhook or application does not have the |
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 |