Get a list of custom fields for deals crm.deal.userfield.list
Scope:
crmWho can execute the method: CRM administrator
The method crm.deal.userfield.list returns a list of custom fields for deals based on the filter.
Method Parameters
|
Name |
Description |
|
filter |
Object format:
All conditions for individual fields are combined using |
|
order |
Object format:
Available fields for sorting:
By default: |
Available fields for filtering
|
Name |
Description |
|
ID |
Identifier of the custom field |
|
FIELD_NAME |
Code of the custom field |
|
USER_TYPE_ID |
Type of the custom field. Possible values:
|
|
XML_ID |
External code |
|
SORT |
Sort index |
|
MULTIPLE |
Whether the custom field is multiple.
|
|
MANDATORY |
Whether the custom field is mandatory. Possible values:
|
|
SHOW_FILTER |
Whether to show in the list filter. Possible values:
|
|
SHOW_IN_LIST |
Whether to show in the list. Possible values:
|
|
EDIT_IN_LIST |
Whether to allow user editing. Possible values:
|
|
IS_SEARCHABLE |
Whether the field values are searchable. Possible values:
|
|
LANG |
Language identifier. When filtering by this parameter, a set of fields with values in the provided language will be returned:
|
Code Examples
How to Use Examples in Documentation
Get a list of custom fields that:
- are multiple,
- are mandatory,
- have custom field labels in German. Thanks to the filter by the
LANGparameter, we will additionally receive field names in the response.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"MULTIPLE":"Y","MANDATORY":"Y","LANG":"de"},"order":{"USER_TYPE_ID":"ASC","SORT":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.userfield.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"MULTIPLE":"Y","MANDATORY":"Y","LANG":"de"},"order":{"USER_TYPE_ID":"ASC","SORT":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.userfield.list
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'crm.deal.userfield.list',
{
filter: {
MULTIPLE: "Y",
MANDATORY: "Y",
LANG: "de",
},
order: {
USER_TYPE_ID: "ASC",
SORT: "ASC",
},
},
(progress: number) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity) }
} catch (error: any) {
console.error('Request failed', error)
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
// The method implements iterative selection using a generator, which
// allows processing data in parts and efficiently using memory.
try {
const generator = $b24.fetchListMethod('crm.deal.userfield.list', {
filter: {
MULTIPLE: "Y",
MANDATORY: "Y",
LANG: "de",
},
order: {
USER_TYPE_ID: "ASC",
SORT: "ASC",
},
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error: any) {
console.error('Request failed', error)
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
// of data retrieval through the start parameter. Suitable for scenarios where
// precise control over request batches is required. However, with large
// volumes of data, it may be less efficient compared to
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const response = await $b24.callMethod('crm.deal.userfield.list', {
filter: {
MULTIPLE: "Y",
MANDATORY: "Y",
LANG: "de",
},
order: {
USER_TYPE_ID: "ASC",
SORT: "ASC",
},
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity) }
} catch (error: any) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'crm.deal.userfield.list',
[
'filter' => [
'MULTIPLE' => 'Y',
'MANDATORY' => 'Y',
'LANG' => 'de',
],
'order' => [
'USER_TYPE_ID' => 'ASC',
'SORT' => 'ASC',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching deal user fields: ' . $e->getMessage();
}
BX24.callMethod(
'crm.deal.userfield.list',
{
filter: {
MULTIPLE: "Y",
MANDATORY: "Y",
LANG: "de",
},
order: {
USER_TYPE_ID: "ASC",
SORT: "ASC",
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.deal.userfield.list',
[
'filter' => [
'MULTIPLE' => "Y",
'MANDATORY' => "N",
'LANG' => "de",
],
'order' => [
'USER_TYPE_ID' => "ASC",
'SORT' => "ASC",
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": [
{
"ID": "5815",
"ENTITY_ID": "CRM_DEAL",
"FIELD_NAME": "UF_CRM_1713790573",
"USER_TYPE_ID": "crm_status",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "I",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"ENTITY_TYPE": "INDUSTRY"
},
"EDIT_FORM_LABEL": "Directory",
"LIST_COLUMN_LABEL": "Directory",
"LIST_FILTER_LABEL": "Directory",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
},
{
"ID": "6799",
"ENTITY_ID": "CRM_DEAL",
"FIELD_NAME": "UF_CRM_1724077760",
"USER_TYPE_ID": "enumeration",
"XML_ID": null,
"SORT": "150",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "E",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"DISPLAY": "LIST",
"LIST_HEIGHT": 1,
"CAPTION_NO_VALUE": "",
"SHOW_NO_VALUE": "Y"
},
"EDIT_FORM_LABEL": "Radio",
"LIST_COLUMN_LABEL": "Radio",
"LIST_FILTER_LABEL": "Radio",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"LIST": [
{
"ID": "3157",
"SORT": "10",
"VALUE": "Children's Radio",
"DEF": "N",
"XML_ID": "79b4c576f96e65eb40f390e45c0dc802"
},
{
"ID": "3159",
"SORT": "20",
"VALUE": "Shanson Radio",
"DEF": "N",
"XML_ID": "d3ffd89a825f218f5efd79dffd38fbbf"
},
{
"ID": "3161",
"SORT": "30",
"VALUE": "Love Radio",
"DEF": "N",
"XML_ID": "dff769fa19d7d7ce8d0677341d221161"
},
{
"ID": "3163",
"SORT": "40",
"VALUE": "Monte Carlo Radio",
"DEF": "N",
"XML_ID": "1f22e5c818ce336a42bd0ec94eb69b9e"
},
{
"ID": "3181",
"SORT": "130",
"VALUE": "DFM Yuriev-Polsky",
"DEF": "N",
"XML_ID": "fc1c5e6b4a9fd20b4749240b8dbac41a"
}
]
},
{
"ID": "6791",
"ENTITY_ID": "CRM_DEAL",
"FIELD_NAME": "UF_CRM_1722578010",
"USER_TYPE_ID": "file",
"XML_ID": null,
"SORT": "150",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "E",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"LIST_WIDTH": 0,
"LIST_HEIGHT": 0,
"MAX_SHOW_SIZE": 0,
"MAX_ALLOWED_SIZE": 0,
"EXTENSIONS": [],
"TARGET_BLANK": "Y"
},
"EDIT_FORM_LABEL": "Estimate (files)",
"LIST_COLUMN_LABEL": "Estimate (files)",
"LIST_FILTER_LABEL": "Estimate (files)",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
},
{
"ID": "5567",
"ENTITY_ID": "CRM_DEAL",
"FIELD_NAME": "UF_CRM_1709565075",
"USER_TYPE_ID": "resourcebooking",
"XML_ID": null,
"SORT": "1",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"USE_USERS": "N",
"USE_RESOURCES": "Y",
"RESOURCES": {
"resource": {
"XML_ID": "resource",
"NAME": "resource",
"SECTIONS": [
{
"ID": "7",
"CAL_TYPE": "resource",
"NAME": "Museum Hall"
},
{
"ID": "49",
"CAL_TYPE": "resource",
"NAME": "resource 1"
},
{
"ID": "51",
"CAL_TYPE": "resource",
"NAME": "resource 2"
},
{
"ID": "53",
"CAL_TYPE": "resource",
"NAME": "1"
},
{
"ID": "57",
"CAL_TYPE": "resource",
"NAME": "Resource"
},
{
"ID": "59",
"CAL_TYPE": "resource",
"NAME": "Resource 2"
}
]
}
},
"SELECTED_RESOURCES": [
{
"type": "resource",
"id": "7",
"title": "Museum Hall"
}
],
"SELECTED_USERS": [],
"FULL_DAY": "N",
"ALLOW_OVERBOOKING": "Y",
"USE_SERVICES": "N",
"SERVICE_LIST": [
{
"name": "",
"duration": "60"
}
],
"RESOURCE_LIMIT": -1,
"TIMEZONE": "Europe/Berlin",
"USE_USER_TIMEZONE": "N"
},
"EDIT_FORM_LABEL": "MEETING ROOM BOOKING",
"LIST_COLUMN_LABEL": "MEETING ROOM BOOKING",
"LIST_FILTER_LABEL": "MEETING ROOM BOOKING",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
},
{
"ID": "6997",
"ENTITY_ID": "CRM_DEAL",
"FIELD_NAME": "UF_CRM_HELLO_WORLD",
"USER_TYPE_ID": "string",
"XML_ID": null,
"SORT": "2000",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "N",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 10,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": "Hello, world! Default value (modified)"
},
"EDIT_FORM_LABEL": "Hello, world! Edit (modified)",
"LIST_COLUMN_LABEL": "Hello, world! Column (modified)",
"LIST_FILTER_LABEL": "Hello, world! Filter (modified)",
"ERROR_MESSAGE": "Hello, world! Error (modified)",
"HELP_MESSAGE": "Hello, world! Help (modified)"
}
],
"total": 5,
"time": {
"start": 1753793143.219832,
"finish": 1753793143.529472,
"duration": 0.30964016914367676,
"processing": 0.06361007690429688,
"date_start": "2025-07-29T15:45:43+02:00",
"date_finish": "2025-07-29T15:45:43+02:00",
"operating_reset_at": 1753793743,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response, contains a list of custom fields. The structure of an individual custom field depends on its type. The fields |
|
total |
The number of found custom fields |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Parameter 'filter' must be array."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
The provided |
|
|
|
The provided |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a Custom Field for Deals crm.deal.userfield.add
- Update Existing Custom Field for Deals crm.deal.userfield.update
- Get Custom Deal Field by ID crm.deal.userfield.get
- Delete Custom Field crm.deal.userfield.delete
- How to Set Up Rounding for a Custom Field of Type "Number"
- How to Save the Payment Date in the Deal Field