Get Custom Lead Field by ID crm.lead.userfield.get
Scope:
crmWho can execute the method: user with read access to leads
The method crm.lead.userfield.get returns a custom lead field by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the custom field associated with the lead. The identifier can be obtained using the methods crm.lead.userfield.add or crm.lead.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.lead.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.lead.userfield.get
try
{
const response = await $b24.callMethod(
'crm.lead.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.lead.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 company user field: ' . $e->getMessage();
}
BX24.callMethod(
'crm.lead.userfield.get',
{
id: 399,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.userfield.get',
[
'id' => 399
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"ID": "6997",
"ENTITY_ID": "CRM_LEAD",
"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": "Hello, World! Column (changed)",
"br": "Hello, World! Column (changed)",
"de": "Hello, World! Column (changed)",
"en": "Hello, World! Column (changed)",
"fr": "Hello, World! Column (changed)",
"hi": "Hello, World! Column (changed)",
"id": "Hello, World! Column (changed)",
"in": "Hello, World! Column (changed)",
"it": "Hello, World! Column (changed)",
"ja": "Hello, World! Column (changed)",
"kz": "Hello, World! Column (changed)",
"la": "Hello, World! Column (changed)",
"ms": "Hello, World! Column (changed)",
"pl": "Hello, World! Column (changed)",
"ru": "Hello, World! Column (changed)",
"sc": "Hello, World! Column (changed)",
"tc": "Hello, World! Column (changed)",
"th": "Hello, World! Column (changed)",
"tr": "Hello, World! Column (changed)",
"ua": "Hello, World! Column (changed)",
"vn": "Hello, World! Column (changed)"
},
"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, containing 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.lead.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 |
|
|
Access denied |
Occurs when:
|
|
|
ID is not defined or invalid |
The provided |
|
|
The entity with ID 'id' is not found |
The custom field with the provided |
Continue Learning
- Create a Custom Field for Leads crm.lead.userfield.add
- Update Existing Custom Field for Leads crm.lead.userfield.update
- Get a List of Custom Fields for Leads crm.lead.userfield.list
- Delete Custom Field for Leads crm.lead.userfield.delete