метод REST
scope: crm
Устаревший
crm.deal.get
Получить сделку по Id
Устаревший метод.
Развитие метода остановлено. Используйте crm.item.get.
Описание
Метод crm.deal.get возвращает сделку по идентификатору.
Параметры
id
integer
обязательный
Идентификатор сделки.
Идентификатор можно получить с помощью методов crm.deal.list или crm.deal.add
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":410}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":410,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CrmDealResult = {
ID: string
TITLE: string
TYPE_ID: string
STAGE_ID: string
CATEGORY_ID: string
OPPORTUNITY: string
CURRENCY_ID: string
PROBABILITY: string
COMPANY_ID: string
CONTACT_ID: string
ASSIGNED_BY_ID: string
OPENED: string
CLOSED: string
BEGINDATE: ISODate | null
CLOSEDATE: ISODate | null
DATE_CREATE: ISODate | null
DATE_MODIFY: ISODate | null
}
try {
const response = await $b24.actions.v2.call.make<CrmDealResult>({
method: 'crm.deal.get',
params: {
id: 410,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Deal:', result.ID, result.TITLE)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getDeal() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.get',
params: {
id: 410,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Deal:', result.ID, result.TITLE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDeal)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.get(bitrix_id=123).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.deal.get',
[
'id' => 410,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Deal data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting deal: ' . $e->getMessage();
}
BX24.callMethod(
'crm.deal.get',
{
id: 410,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.deal.get',
[
'ID' => 410
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.get", b24.Params{
"id": 410,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.deal.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
Title string `json:"TITLE"`
TypeID string `json:"TYPE_ID"`
StageID string `json:"STAGE_ID"`
Probability string `json:"PROBABILITY"`
CurrencyID string `json:"CURRENCY_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Title)
Ответ
HTTP-статус: 200
{
"result": {
"ID": "410",
"TITLE": "Новая сделка #1",
"TYPE_ID": "COMPLEX",
"STAGE_ID": "PREPARATION",
"PROBABILITY": "99",
"CURRENCY_ID": "EUR",
"OPPORTUNITY": "1000000.00",
"IS_MANUAL_OPPORTUNITY": "Y",
"TAX_VALUE": "0.00",
"LEAD_ID": null,
"COMPANY_ID": "9",
"CONTACT_ID": "84",
"QUOTE_ID": null,
"BEGINDATE": "2024-08-30T02:00:00+02:00",
"CLOSEDATE": "2024-09-09T02:00:00+02:00",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-08-30T14:29:00+02:00",
"DATE_MODIFY": "2024-08-30T14:29:00+02:00",
"OPENED": "Y",
"CLOSED": "N",
"COMMENTS": "[B]Пример комментария[\/B]",
"ADDITIONAL_INFO": "Дополнительная информация",
"LOCATION_ID": null,
"CATEGORY_ID": "0",
"STAGE_SEMANTIC_ID": "P",
"IS_NEW": "N",
"IS_RECURRING": "N",
"IS_RETURN_CUSTOMER": "N",
"IS_REPEATED_APPROACH": "N",
"SOURCE_ID": "CALLBACK",
"SOURCE_DESCRIPTION": "Дополнительно об источнике",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-08-30T14:29:00+02:00",
"LAST_ACTIVITY_TIME": "2024-08-30T14:29:00+02:00",
"UTM_SOURCE": "google",
"UTM_MEDIUM": "CPC",
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"PARENT_ID_1220": "22",
"LAST_ACTIVITY_BY": "1",
"UF_CRM_1721244482250": "Привет мир!"
},
"time": {
"start": 1725020945.541275,
"finish": 1725020946.179076,
"duration": 0.637800931930542,
"processing": 0.21427488327026367,
"date_start": "2024-08-30T14:29:05+02:00",
"date_finish": "2024-08-30T14:29:06+02:00",
"operating": 0
}
}
Возвращаемые данные
result
deal
Корневой элемент ответа. Содержит информацию о полях сделки. Структура описана ниже
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'fields' must be array."
}
| Код | Описание | Значение |
|---|---|---|
| — | ID is not defined or invalid |
В параметр id либо не передано значение, либо оно является не целым числом больше нуля |
| — | Access denied |
У пользователя нет прав на «чтение» данной сделки |
| — | Not found |
Сделки с переданным id не существует |

