Retrieve Fields of CRM Item
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so the assistant can utilize the official REST documentation.
Scope:
crmWho can execute the method: any user with "read" access permission for CRM object elements.
This method retrieves a list of fields and their configuration for elements of type entityTypeId.
Warning
Elements belonging to different types of CRM objects will have different sets of fields.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the system or custom type whose fields we want to retrieve. Numeric values for system types (Lead — 1, Deal — 2, Contact — 3, Company — 4, Invoice — 31, etc.) are listed in the CRM object types reference. The identifier for the SPA can be obtained using the crm.type.list method. |
|
useOriginalUfNames |
This parameter controls the format of custom field names in the response.
Default is |
Code Examples
How to Use Examples in Documentation
Retrieve the list of fields for SPA elements with entityTypeId = 1268
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":1268,"useOriginalUfNames":"N"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":1268,"useOriginalUfNames":"N","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.fields
try
{
const response = await $b24.callMethod(
'crm.item.fields',
{
entityTypeId: 1268,
useOriginalUfNames: 'N',
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.item.fields',
[
'entityTypeId' => 1268,
'useOriginalUfNames' => 'N',
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
return;
}
echo 'Success: ' . print_r($result->data(), true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching CRM item fields: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.fields',
{
entityTypeId: 1268,
useOriginalUfNames: 'N',
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.item.fields',
[
'entityTypeId' => 1268,
'useOriginalUfNames' => 'N',
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"fields": {
"id": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID",
"upperName": "ID"
},
"title": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Title",
"upperName": "TITLE"
},
"xmlId": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "External Code",
"upperName": "XML_ID"
},
"createdTime": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Created Time",
"upperName": "CREATED_TIME"
},
"updatedTime": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Updated Time",
"upperName": "UPDATED_TIME"
},
"createdBy": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Created By",
"upperName": "CREATED_BY"
},
"updatedBy": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Updated By",
"upperName": "UPDATED_BY"
},
"assignedById": {
"type": "user",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Responsible",
"upperName": "ASSIGNED_BY_ID"
},
"opened": {
"type": "boolean",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Available to All",
"upperName": "OPENED"
},
"webformId": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Created by CRM Form",
"upperName": "WEBFORM_ID"
},
"begindate": {
"type": "date",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Start Date",
"upperName": "BEGINDATE"
},
"closedate": {
"type": "date",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "End Date",
"upperName": "CLOSEDATE"
},
"companyId": {
"type": "crm_company",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Company",
"settings": {
"parentEntityTypeId": 4
},
"upperName": "COMPANY_ID"
},
"contactId": {
"type": "crm_contact",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"isDeprecated": true,
"title": "Contact",
"upperName": "CONTACT_ID"
},
"contactIds": {
"type": "crm_contact",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "CONTACT_IDS",
"upperName": "CONTACT_IDS"
},
"contacts": {
"type": "crm_contact",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "CONTACTS",
"upperName": "CONTACTS"
},
"observers": {
"type": "user",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Observers",
"upperName": "OBSERVERS"
},
"categoryId": {
"type": "crm_category",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Sales Funnel",
"upperName": "CATEGORY_ID"
},
"movedTime": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Moved Time",
"upperName": "MOVED_TIME"
},
"movedBy": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Moved By",
"upperName": "MOVED_BY"
},
"stageId": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "DYNAMIC_1268_STAGE_52",
"title": "Stage",
"upperName": "STAGE_ID"
},
"previousStageId": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "DYNAMIC_1268_STAGE_52",
"title": "Previous Stage",
"upperName": "PREVIOUS_STAGE_ID"
},
"sourceId": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "SOURCE",
"title": "Source",
"upperName": "SOURCE_ID"
},
"sourceDescription": {
"type": "text",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Additional Source Information",
"upperName": "SOURCE_DESCRIPTION"
},
"currencyId": {
"type": "crm_currency",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Currency",
"upperName": "CURRENCY_ID"
},
"isManualOpportunity": {
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Manual Opportunity Mode",
"upperName": "IS_MANUAL_OPPORTUNITY"
},
"opportunity": {
"type": "double",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Amount",
"upperName": "OPPORTUNITY"
},
"taxValue": {
"type": "double",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Tax Amount",
"upperName": "TAX_VALUE"
},
"mycompanyId": {
"type": "crm_company",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Your Company Details",
"settings": {
"isMyCompany": true,
"parentEntityTypeId": 4,
"isEmbeddedEditorEnabled": true
},
"upperName": "MYCOMPANY_ID"
},
"lastActivityBy": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Last Activity By",
"upperName": "LAST_ACTIVITY_BY"
},
"lastActivityTime": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Last Activity",
"upperName": "LAST_ACTIVITY_TIME"
},
"parentId1": {
"type": "crm_entity",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Lead",
"settings": {
"parentEntityTypeId": 1
},
"upperName": "PARENT_ID_1"
},
"parentId2": {
"type": "crm_entity",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Deal",
"settings": {
"parentEntityTypeId": 2
},
"upperName": "PARENT_ID_2"
},
"parentId1248": {
"type": "crm_entity",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "SPA #16",
"settings": {
"parentEntityTypeId": 1248
},
"upperName": "PARENT_ID_1248"
}
}
},
"time": {
"start": 1721038185.626335,
"finish": 1721038186.072804,
"duration": 0.4464690685272217,
"processing": 0.17344903945922852,
"date_start": "2024-07-15T12:09:45+02:00",
"date_finish": "2024-07-15T12:09:46+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response. Contains a single key |
|
fields |
An object in the format: where:
|
|
time |
Information about the request execution time |
By default, custom field names are returned in camelCase, e.g., ufCrm2_1639669411830.
When passing the useOriginalUfNames parameter with the value Y, custom fields will be returned with their original names, e.g., UF_CRM_2_1639669411830.
Error Handling
HTTP Status: 400, 403
{
"error": "NOT_FOUND",
"error_description": "SPA not found"
}
|
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
|
Status |
Code |
Description |
Value |
|
|
|
Action allowed only for intranet users |
User is not an intranet user |
|
|
|
SPA not found |
Occurs when an invalid |
|
|
|
You do not have permission to view this element |
User does not have read access permission for elements of type |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |
Continue Learning
- Create a New CRM Entity crm.item.add
- Update CRM Item
- Get Element by Id crm.item.get
- Get a List of CRM Items: crm.item.list
- Delete CRM Item: crm.item.delete
- CRM Object Fields