Get a CRM Item by ID v 3.0 crm.[type].get
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with permission to view items of this CRM object type. For my company, a CRM administrator
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The crm.<type>.get method returns the fields of a CRM item by ID. The object type is set by the <type> segment of the method name, and the set of fields in the response is set by the select parameter.
Method Name for the Object Type
|
Object type |
Method |
Fields |
|
Deal |
|
|
|
Lead |
|
|
|
Contact |
|
|
|
Company |
|
|
|
Estimate |
|
|
|
Invoice |
|
|
|
My company |
|
|
|
SPA |
|
For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field.
The method name is written in lowercase: crm.smartinvoice.get, not crm.smartInvoice.get. If the name is written in a different case, the method returns the "Method Not Found" error.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Item ID. The ID is returned by the crm.<type>.add method when an item is created. IDs of existing items can be retrieved with the crm.<type>.list method |
|
select |
List of fields to return in the response. Parameter description If the parameter is not passed, the response contains only |
The select Parameter
Field names are written in camelCase: title, stageId, assignedById. Each object type has its own set of fields, which are described on these pages:
- deal fields
- lead fields
- contact fields
- company fields
- estimate fields
- invoice fields
- my company fields
- SPA fields
The list of fields is returned by the crm.<type>.field.list method.
The response contains only the fields from select. The id field is not added automatically — include it in the list if you need it in the response. The asterisk * is not supported: the method returns an unknown field error.
Linked objects are requested by the field name without the Id suffix: assignedBy, createdBy, stage, category. There are two ways to do this:
- the whole linked object name, for example,
assignedBy, — the response contains all fields of the object. For linked CRM items, such ascontact,company, and others, onlyidis returned - a dot-separated path, for example,
assignedBy.firstNameorstage.name, — the response contains only the selected fields of the object
If a link is not set, the linked object is returned as null, and a multiple one, for example, observers, is returned as an empty array.
Custom fields are passed by name, for example, UF_CRM_1687529546. Their list is returned by the crm.<type>.field.custom.list method.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.smartprocess1038.get
The examples retrieve an SPA item with the type ID 1038: the name, the stage with its name, the responsible person with their first and last name, the amount, and the creation date. For a different object type, replace the method name according to the table above.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15,"select":["id","title","stageId","stage.name","assignedById","assignedBy.firstName","assignedBy.lastName","opportunity","currencyId","createdTime"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15,"select":["id","title","stageId","stage.name","assignedById","assignedBy.firstName","assignedBy.lastName","opportunity","currencyId","createdTime"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.get
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ItemGetResult = {
item: {
id: number
title: string
stageId: string
assignedById: number
opportunity: number
currencyId: string
createdTime: string
stage: {
name: string
} | null
assignedBy: {
firstName: string
lastName: string
} | null
}
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<ItemGetResult>(
'crm.smartprocess1038.get',
{
id: 15,
select: [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const item = response.getData()!.result.item
console.info(item.title, item.stage?.name, item.assignedBy?.firstName)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getItem() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.smartprocess1038.get',
{
id: 15,
select: [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const item = response.getData().result.item
console.info(item.title, item.stage?.name, item.assignedBy?.firstName)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getItem)
</script>
b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.smartprocess1038.get"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"id": 15,
"select": [
"id",
"title",
"stageId",
"stage.name",
"assignedById",
"assignedBy.firstName",
"assignedBy.lastName",
"opportunity",
"currencyId",
"createdTime",
],
},
prefer_version=3,
)
item = response["result"]["item"]
print(item)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'crm.smartprocess1038.get',
[
'id' => 15,
'select' => [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'crm.smartprocess1038.get',
{
id: 15,
select: [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'crm.smartprocess1038.get',
[
'id' => 15,
'select' => [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.smartprocess1038.get", b24.Params{
"id": 15,
"select": []string{
"id",
"title",
"stageId",
"stage.name",
"assignedById",
"assignedBy.firstName",
"assignedBy.lastName",
"opportunity",
"currencyId",
"createdTime",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.smartprocess1038.get: %w", err)
}
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item in response")
}
var item struct {
ID int `json:"id"`
Title string `json:"title"`
StageID string `json:"stageId"`
Opportunity float64 `json:"opportunity"`
CurrencyID string `json:"currencyId"`
Stage struct {
Name string `json:"name"`
} `json:"stage"`
AssignedBy struct {
FirstName string `json:"firstName"`
LastName string `json:"lastName"`
} `json:"assignedBy"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Title, item.Stage.Name, item.AssignedBy.FirstName)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 15,
"title": "Equipment purchase request",
"stageId": "DT1038_69:PREPARATION",
"assignedById": 1,
"opportunity": 180000,
"currencyId": "EUR",
"createdTime": "2026-11-03T14:39:32+03:00",
"stage": {
"name": "Preparation"
},
"assignedBy": {
"firstName": "Anna",
"lastName": "Schmidt"
}
}
},
"time": {
"start": 1793706172,
"finish": 1793706172.777702,
"duration": 0.7777020931243896,
"processing": 0,
"date_start": "2026-11-03T14:42:52+03:00",
"date_finish": "2026-11-03T14:42:52+03:00",
"operating_reset_at": 1793706720,
"operating": 0
}
}
Without the select parameter, the method returns only the ID:
{
"result": {
"item": {
"id": 15
}
},
"time": {
"start": 1793705990,
"finish": 1793705990.170455,
"duration": 0.1704549789428711,
"processing": 0,
"date_start": "2026-11-03T14:39:50+03:00",
"date_finish": "2026-11-03T14:39:50+03:00",
"operating_reset_at": 1793706540,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
result.item |
Values of the item fields from |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
"message": "Unknown field \"name\" found in entity \"EmployeeDto\"."
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Item Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID #ID# was not found |
Check the item ID. This object type has no item with this |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the item |
|
|
Field value must be 1 or greater |
Pass a positive ID |
|
|
This request requires data type |
Pass |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Check the field name in |
Select Format Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid field in |
Pass |
Method Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Method |
Check the method name: it is written in lowercase, for example, |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |