For AI agents: markdown of this page — /docs-content-en/entities/deals/get.md documentation index — /llms.txt

Get deal

GET /v1/deals/:id

Returns a deal by ID with all fields, including user fields (ufCrm_*).

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionDeal ID. List: GET /v1/deals
Parameterinclude (query) Typestring Requiredno DescriptionRelated data to include, comma-separated: contact, company. See the "Related data" section
Parameterselect (query) Typestring Requiredno DescriptionComma-separated response fields, for example id,title,amount. Without it, every field is returned. Names come from Deal fields

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

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

const { success, data } = await res.json()
console.log('Deal:', data.title, '—', data.amount, data.currency)

JavaScript — OAuth application

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

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

More on includes: Related data.

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue when the request succeeds
Fielddata Typeobject DescriptionThe deal with all fields, including user fields (ufCrm_*). All fields — Deal fields
Fielddata._included Typeobject DescriptionRelated entities. Returned only with the include parameter — see the "Related data" section

To retrieve related entities together with the deal, use the include parameter in the GET request:

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

Available includes: contact, company. The result is in the _included field:

JSON 
{
  "success": true,
  "data": {
    "id": 741,
    "title": "Equipment delivery",
    "_included": {
      "contacts": [{ "id": 71, "name": "John Brown", ... }],
      "company": { "id": 15, "title": "Acme LLC", ... }
    }
  }
}

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 741,
    "title": "Equipment delivery",
    "amount": 50000,
    "currency": "USD",
    "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": []
  }
}

The response contains all deal fields, including user fields (ufCrm_*). The main ones are shown above.

Error response example

404 — deal not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Item not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionDeal with this ID not found
HTTP400 CodeINVALID_INCLUDE Descriptioninclude contains an unknown name. The message lists the allowed ones: contact, company
HTTP400 CodeUNKNOWN_SELECT_FIELD Descriptionselect contains an unknown field. The message lists the allowed names
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionNo access to the deal
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens

Full list of common API errors — Errors.

See also