## Get deal

`GET /v1/deals/:id`

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

## Parameters

| Parameter | Type | Req. | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Deal ID |

## Examples

### curl — personal key

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

### curl — OAuth app

```bash
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 app

```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 include: [Related data](/docs/includes).

## Response fields

The deal object with all fields — see [Deal fields](/docs/entities/deals/fields).

## Related data

To retrieve related entities together with the deal — the `include` parameter in the GET request:

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

Available include: `contact`, `company`, `quote`. 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": [],
    "entityTypeId": 2
  }
}
```

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 |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | Deal with this ID not found |
| 403 | `ACCESS_DENIED` | No access to the deal |
| 403 | `SCOPE_DENIED` | API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | API key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [Working with files in CRM fields](/docs/recipes/crm-files)
- [Deal fields](/docs/entities/deals/fields) — all fields
- [Update deal](/docs/entities/deals/update) — modifying fields
- [List deals](/docs/entities/deals/list) — search with filters
- [Limits and optimization](/docs/optimization) — rate limits