#Получить сделку

GET /v1/deals/:id

Возвращает сделку по ID со всеми полями, включая пользовательские (ufCrm_*).

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID сделки

#Примеры

#curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/deals/741" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/deals/741" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/741', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Сделка:', data.title, '—', data.amount, data.currency)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/741', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Подробнее об include: Связанные данные.

#Поля ответа

Объект сделки со всеми полями — см. Поля сделки.

#Связанные данные

Получить связанные сущности вместе со сделкой — параметр include в GET-запросе:

GET /v1/deals/741?include=contact,company

Доступные include: contact, company, quote. Результат в поле _included:

JSON 
{
  "success": true,
  "data": {
    "id": 741,
    "title": "Поставка оборудования",
    "_included": {
      "contacts": [{ "id": 71, "name": "Иван Петров", ... }],
      "company": { "id": 15, "title": "ООО Ромашка", ... }
    }
  }
}

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 741,
    "title": "Поставка оборудования",
    "amount": 50000,
    "currency": "RUB",
    "stageId": "EXECUTING",
    "categoryId": 0,
    "assignedById": 29,
    "createdBy": 1,
    "createdAt": "2020-09-25T13:08:24.000Z",
    "updatedAt": "2025-08-22T13:01:31.000Z",
    "contactId": 71,
    "companyId": 0,
    "opened": true,
    "observers": [],
    "contactIds": [],
    "entityTypeId": 2
  }
}

#Пример ответа при ошибке

404 — сделка не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Сделка с таким ID не найдена
403 ACCESS_DENIED Нет доступа к сделке
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

#Смотрите также