Get Custom Deal Field by ID crm.deal.userfield.get
Scope:
crmWho can execute the method: CRM administrator
The method crm.deal.userfield.get returns a custom deal field by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the custom field associated with the deal. The identifier can be obtained using the methods crm.deal.userfield.add or crm.deal.userfield.list |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":399}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.userfield.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":399,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.userfield.get
try
{
const response = await $b24.callMethod(
'crm.deal.userfield.get',
{
id: 399,
}
);
const result = response.getData().result;
result.error()
? console.error(result.error())
: console.info(result)
;
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.deal.userfield.get',
[
'id' => 399,
]
);
$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 getting deal user field: ' . $e->getMessage();
}
BX24.callMethod(
'crm.deal.userfield.get',
{
id: 399,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.deal.userfield.get',
[
'id' => 399
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"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 (changed)"
},
"EDIT_FORM_LABEL": {
"ar": "",
"br": "",
"de": "Hallo, Welt! Bearbeiten (geändert)",
"en": "Hello, World! Edit (changed)",
"fr": "",
"hi": "",
"id": "",
"in": "",
"it": "",
"ja": "",
"kz": "",
"la": "",
"ms": "",
"pl": "",
"ru": "",
"sc": "",
"tc": "",
"th": "",
"tr": "",
"ua": "",
"vn": ""
},
"LIST_COLUMN_LABEL": {
"ar": "",
"br": "",
"de": "Hallo, Welt! Spalte (geändert)",
"en": "Hello, World! Column (changed)",
"fr": "",
"hi": "",
"id": "",
"in": "",
"it": "",
"ja": "",
"kz": "",
"la": "",
"ms": "",
"pl": "",
"ru": "",
"sc": "",
"tc": "",
"th": "",
"tr": "",
"ua": "",
"vn": ""
},
"LIST_FILTER_LABEL": {
"ar": "",
"br": "",
"de": "Hallo, Welt! Filter (geändert)",
"en": "Hello, World! Filter (changed)",
"fr": "",
"hi": "",
"id": "",
"in": "",
"it": "",
"ja": "",
"kz": "",
"la": "",
"ms": "",
"pl": "",
"ru": "",
"sc": "",
"tc": "",
"th": "",
"tr": "",
"ua": "",
"vn": ""
},
"ERROR_MESSAGE": {
"ar": "",
"br": "",
"de": "Hallo, Welt! Fehler (geändert)",
"en": "Hello, World! Error (changed)",
"fr": "",
"hi": "",
"id": "",
"in": "",
"it": "",
"ja": "",
"kz": "",
"la": "",
"ms": "",
"pl": "",
"ru": "",
"sc": "",
"tc": "",
"th": "",
"tr": "",
"ua": "",
"vn": ""
},
"HELP_MESSAGE": {
"ar": "",
"br": "",
"de": "Hallo, Welt! Hilfe (geändert)",
"en": "Hello, World! Help (changed)",
"fr": "",
"hi": "",
"id": "",
"in": "",
"it": "",
"ja": "",
"kz": "",
"la": "",
"ms": "",
"pl": "",
"ru": "",
"sc": "",
"tc": "",
"th": "",
"tr": "",
"ua": "",
"vn": ""
}
},
"time": {
"start": 1753790529.430936,
"finish": 1753790529.487882,
"duration": 0.05694580078125,
"processing": 0.0039789676666259766,
"date_start": "2025-07-29T15:02:09+02:00",
"date_finish": "2025-07-29T15:02:09+02:00",
"operating_reset_at": 1753791129,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response, contains information about the custom field. The final list of fields depends on the field type, detailed descriptions of the fields can be found in the method crm.deal.userfield.add |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "ID is not defined or invalid."
}
|
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 |
|
|
|
Occurs when:
|
|
|
|
The provided |
|
|
|
The custom field with 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 a list of custom fields for deals crm.deal.userfield.list
- Delete Custom Field crm.deal.userfield.delete