## Deal product rows

`GET /v1/deals/:id/products`

Returns the list of product rows attached to a deal.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Deal ID |
| `limit` (query) | number | no | How many rows to return per call, from 1 to 5000, 50 by default. A value above 5000 is clamped to 5000. `limit=0` is not a page size: the default applies and `meta.warnings` carries an entry with code `LIMIT_ZERO_IGNORED` |
| `offset` (query) | number | no | Offset in rows, not in pages: `offset=7` starts the output at the eighth row |

Without `limit` and `offset` the endpoint returns the first page of results. `meta.hasMore` tells you whether rows exist beyond it, and `meta.total` how many the deal has in total.

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/deals/741/products" \
  -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/products', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Products:', data.length)
```

### JavaScript — OAuth application

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

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of product rows. All row fields — [Product fields](/docs/entities/deals/products-fields) |
| `meta.total` | number | How many product rows the deal has in total. Present when Bitrix24 returned the count, otherwise the field is absent from the response. |
| `meta.hasMore` | boolean | Whether rows exist beyond the returned page. Correct for any requested window, not only the first one |
| `meta.warnings` | array | Present only when the request carried `limit=0`: a single entry with `code` equal to `LIMIT_ZERO_IGNORED` |

`data[].id` is the product row ID, the same value used as `rowId` in single-row operations. `data[].ownerId` matches the deal ID from the request path, and `data[].ownerType` is `D` for a deal. `data[].taxIncluded` is returned as a `boolean`. `data[].storeId` is a warehouse ID from [`GET /v1/warehouses`](/docs/entities/warehouses/list), or `null` when inventory management is off.

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 1663,
      "ownerId": 741,
      "ownerType": "D",
      "productId": 1,
      "productName": "Server equipment",
      "price": 1000,
      "quantity": 2,
      "discount": 0,
      "taxRate": null,
      "taxIncluded": false,
      "storeId": null
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}
```

## 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 not found |
| 403 | `SCOPE_DENIED` | API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | API key has no configured tokens |
| 429 | `RATE_LIMITED` | Rate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the `x-ratelimit-limit` header. Retry after the delay in the `Retry-After` header |

For the full list of common API errors, see [Errors](/docs/errors).

## See also

- [Set products](/docs/entities/deals/products-set)
- [Get a deal](/docs/entities/deals/get)
- [CRM products](/docs/entities/products)
- [Limits and optimization](/docs/optimization)