Search deals

POST /v1/deals/search

Search deals with filters and auto-pagination. Equivalent to GET /v1/deals with filters, but via POST — more convenient for complex requests with many conditions.

Request fields (body)

Examples

curl — personal key

curl -X POST "https://vibecode.bitrix24.com/v1/deals/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "stageId": "NEW" },
    "limit": 10,
    "order": { "amount": "desc" }
  }'

curl — OAuth application

curl -X POST "https://vibecode.bitrix24.com/v1/deals/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "stageId": "NEW" },
    "limit": 10,
    "order": { "amount": "desc" }
  }'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/deals/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { stageId: 'NEW' },
    limit: 10,
    order: { amount: 'desc' },
  }),
})

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

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/deals/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { stageId: 'NEW' },
    limit: 10,
    order: { amount: 'desc' },
  }),
})

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

Response fields

The meta fields sit next to data, not inside it. Paginate using meta.hasMore: a data length equal to limit does not rule out the last page.

The card URL of any deal from the data array is built from its id:

https://<portal>.bitrix24.com/crm/deal/details/<id>/

<portal> — the Bitrix24 portal domain. Access is restricted by the employee's permissions in Bitrix24.

Response example

{
  "success": true,
  "data": [
    {
      "id": 3865,
      "title": "Template",
      "amount": 0,
      "currency": "USD",
      "stageId": "NEW",
      "categoryId": 0,
      "assignedById": 29,
      "createdAt": "2021-01-13T13:52:44.000Z"
    }
  ],
  "meta": {
    "total": 1915,
    "hasMore": true,
    "durationMs": 690
  }
}

With a date-range filter wider than 14 days, meta additionally returns autoWindowed, windowCount, and batchWaves:

{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 618,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 78,
    "batchWaves": 2,
    "durationMs": 2742
  }
}

Error response example

403 — no scope:

{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Errors

For the full list of common API errors, see Errors.

Known specifics

Time-window splitting. A date-range filter wider than 14 days is automatically split into weekly windows executed in parallel waves, so the result set bypasses the ceiling of 5000 records per call. meta then returns autoWindowed: true, the number of windows windowCount, and the number of waves batchWaves. The autoWindow: false parameter disables splitting. While splitting is active, an offset greater than zero is rejected with UNSTABLE_OFFSET_PAGINATION.

Reports on closed deals are filtered by closedAt. A deal's closing date is the closedAt field (ISO 8601 in the Bitrix24 account's time zone), filled in when the deal moves to a final stage. The field name is exactly closedAt — not closedDate. For a "won/lost over a period" report, filter by the closedAt range:

{
  "filter": {
    "closedAt": { "$gte": "2026-01-01", "$lte": "2026-01-31T23:59:59" }
  }
}

To separate won from lost deals, add the stage (stageId) to the filter. For the main deal pipeline (categoryId = 0), get its final stages from GET /v1/statuses?filter[entityId]=DEAL_STAGE; for an additional pipeline (categoryId = N), use GET /v1/statuses?filter[entityId]=DEAL_STAGE_{categoryId} (for example, categoryId = 1 → DEAL_STAGE_1). Pass the string data[].statusId from the selected status directory as the stageId filter value.

See also

• List deals
• Filtering syntax
• Batch
• Limits and optimization