Get Item by Id crm.item.get
Scope:
crmWho can execute the method: any user with "read" access permission for CRM object elements
The method returns information about an item by its identifier and the identifier of the CRM object type.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the system or user-defined type whose item we want to retrieve |
|
id* |
Identifier of the item whose information we want to obtain. It can be retrieved using the |
|
useOriginalUfNames |
This parameter is used to control the format of custom field names in the response.
Default is |
Code Examples
How to Use Examples in Documentation
Get information about a lead with id = 250
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":1,"id":250,"useOriginalUfNames":"N"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":1,"id":250,"useOriginalUfNames":"N","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.get
try
{
const response = await $b24.callMethod(
'crm.item.get',
{
entityTypeId: 1,
id: 250,
useOriginalUfNames: 'N',
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$entityTypeId = 1; // Example entity type ID
$id = 123; // Example item ID
$itemResult = $serviceBuilder
->getCRMScope()
->item()
->get($entityTypeId, $id);
$item = $itemResult->item();
print("ID: " . $item->id . PHP_EOL);
print("XML ID: " . $item->xmlId . PHP_EOL);
print("Title: " . $item->title . PHP_EOL);
print("Created By: " . $item->createdBy . PHP_EOL);
print("Updated By: " . $item->updatedBy . PHP_EOL);
print("Moved By: " . $item->movedBy . PHP_EOL);
print("Created Time: " . $item->createdTime->format(DATE_ATOM) . PHP_EOL);
print("Updated Time: " . $item->updatedTime->format(DATE_ATOM) . PHP_EOL);
print("Moved Time: " . $item->movedTime->format(DATE_ATOM) . PHP_EOL);
print("Category ID: " . $item->categoryId . PHP_EOL);
print("Opened: " . ($item->opened ? 'true' : 'false') . PHP_EOL);
print("Previous Stage ID: " . $item->previousStageId . PHP_EOL);
print("Begin Date: " . $item->begindate->format(DATE_ATOM) . PHP_EOL);
print("Close Date: " . $item->closedate->format(DATE_ATOM) . PHP_EOL);
print("Company ID: " . $item->companyId . PHP_EOL);
print("Contact ID: " . $item->contactId . PHP_EOL);
print("Opportunity: " . $item->opportunity . PHP_EOL);
print("Is Manual Opportunity: " . ($item->isManualOpportunity ? 'true' : 'false') . PHP_EOL);
print("Tax Value: " . $item->taxValue . PHP_EOL);
print("Currency ID: " . $item->currencyId . PHP_EOL);
print("Opportunity Account: " . $item->opportunityAccount . PHP_EOL);
print("Tax Value Account: " . $item->taxValueAccount . PHP_EOL);
print("Account Currency ID: " . $item->accountCurrencyId . PHP_EOL);
print("My Company ID: " . $item->mycompanyId . PHP_EOL);
print("Source ID: " . $item->sourceId . PHP_EOL);
print("Source Description: " . $item->sourceDescription . PHP_EOL);
print("Webform ID: " . $item->webformId . PHP_EOL);
print("Assigned By ID: " . $item->assignedById . PHP_EOL);
print("Last Activity By: " . $item->lastActivityBy . PHP_EOL);
print("Last Activity Time: " . $item->lastActivityTime->format(DATE_ATOM) . PHP_EOL);
print("UTM Source: " . $item->utmSource . PHP_EOL);
print("UTM Medium: " . $item->utmMedium . PHP_EOL);
print("UTM Campaign: " . $item->utmCampaign . PHP_EOL);
print("UTM Content: " . $item->utmContent . PHP_EOL);
print("UTM Term: " . $item->utmTerm . PHP_EOL);
print("Observers: " . json_encode($item->observers) . PHP_EOL);
print("Contact IDs: " . json_encode($item->contactIds) . PHP_EOL);
print("Entity Type ID: " . $item->entityTypeId . PHP_EOL);
} catch (Throwable $e) {
print("Error: " . $e->getMessage() . PHP_EOL);
}
BX24.callMethod(
'crm.item.get',
{
entityTypeId: 1,
id: 250,
useOriginalUfNames: 'N',
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.item.get',
[
'entityTypeId' => 1,
'id' => 250,
'useOriginalUfNames' => 'N',
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"item": {
"id": 250,
"createdTime": "2024-07-22T18:00:08+02:00",
"dateCreateShort": null,
"updatedTime": "2024-07-22T18:00:08+02:00",
"dateModifyShort": null,
"createdBy": 1,
"updatedBy": 1,
"assignedById": 1,
"opened": "Y",
"companyId": 0,
"contactId": 0,
"stageId": "IN_PROCESS",
"isConvert": null,
"statusDescription": null,
"stageSemanticId": "P",
"productId": null,
"opportunity": 999.9,
"currencyId": "USD",
"sourceId": "TRADE_SHOW",
"sourceDescription": "Admin Exhibition",
"title": "Lead #250",
"name": "James",
"lastName": "Johnson",
"secondName": "Alexander",
"shortName": null,
"companyTitle": "Administrative Company",
"post": "Admin",
"address": null,
"comments": "[B]Comment about admin[/B]",
"webformId": 0,
"originatorId": null,
"originId": null,
"dateClosed": null,
"birthdate": "2000-01-01T02:00:00+02:00",
"honorific": "UC_N1LWUS",
"hasPhone": "Y",
"hasEmail": "Y",
"hasImol": "N",
"login": null,
"isReturnCustomer": "N",
"searchContent": "250 Lead #250 James Johnson Alexander Administrative Company 999.90 US Dollar 6111111111 111111111 11111111 1111111 111111 11111 1111 111 nqzva rknzcyr pbz In Process Exhibition Exhibition about Admin City Admin [O]Comment about admin[/O] 321",
"isManualOpportunity": "Y",
"movedBy": 1,
"movedTime": "2024-07-22T17:00:08+02:00",
"lastActivityBy": 1,
"lastActivityTime": "2024-07-22T17:00:08+02:00",
"phoneMobile": "",
"phoneWork": "+16111111111",
"phoneMailing": "",
"emailHome": "",
"emailWork": "admin@example.com",
"emailMailing": "",
"skype": null,
"icq": null,
"imol": "",
"email": "admin@example.com",
"phone": "+16111111111",
"ufCrm_1720019876534": "321",
"parentId1222": null,
"parentId1226": null,
"parentId1228": null,
"parentId1236": null,
"parentId1238": null,
"parentId1240": null,
"parentId1244": null,
"parentId1246": null,
"parentId1254": null,
"parentId1256": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"observers": [],
"contactIds": [],
"entityTypeId": 1
}
},
"time": {
"start": 1721660468.931424,
"finish": 1721660469.416092,
"duration": 0.4846680164337158,
"processing": 0.16368508338928223,
"date_start": "2024-07-22T17:01:08+02:00",
"date_finish": "2024-07-22T17:01:09+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains a single key |
|
item |
Information about the item, field description |
|
time |
Object containing information about the request execution time |
By default, custom field names are returned in camelCase, e.g., ufCrm2_1639669411830.
When passing the parameter useOriginalUfNames 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": "Item 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 |
|
|
|
Item not found |
Item with the given |
|
|
|
You do not have permission to view this item |
User does not have read access permission for items 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 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 new CRM entity crm.item.add
- Update CRM Item: crm.item.update
- Get a list of crm.item.list elements
- Delete CRM Item - crm.item.delete
- Get Fields of CRM Item `crm.item.fields`
- CRM Object Fields