Search leads

POST /v1/leads/search

Search leads by conditions in the request body. Accepts the same filters as the lead list and is designed for compound conditions and large result sets.

Request fields (body)

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

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

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

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/leads/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', '>=amount': 1000 },
    limit: 10,
    order: { createdTime: '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 lead from the data array is built from its id:

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

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

Response example

{
  "success": true,
  "data": [
    {
      "id": 42,
      "title": "Website request #42",
      "stageId": "NEW",
      "opportunity": 1500,
      "currencyId": "USD",
      "assignedById": 1,
      "sourceId": "WEB",
      "createdTime": "2026-04-10T14:30:00+00:00"
    }
  ],
  "meta": {
    "total": 31,
    "hasMore": true,
    "durationMs": 653
  }
}

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

{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 43,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 131,
    "batchWaves": 3,
    "durationMs": 1653
  }
}

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.

Filtering and sorting by stage semantics. The stageSemanticId field takes three values — P for stages in progress, S for successful ones, and F for failed ones. In filter both an exact match { "stageSemanticId": "S" } and a list { "stageSemanticId": { "$in": ["S", "F"] } } work; order accepts { "stageSemanticId": "asc" }. A value outside those three is not rejected: no record matches it, and data comes back empty. Grouping by this field is not supported in Aggregate leads.

The phone filter is not suitable for every search. A value without an operator is compared against the whole stored string: a lead whose number is stored as +1 (202) 555-0123 matches that exact string, but not 12025550123, because the plus sign, spaces, parentheses, and hyphens are part of the value. The filter also checks only the first number stored on a record: if both a work number and a mobile number are stored, searching by the mobile one returns an empty list. To find a lead by phone number in any format and by any of its numbers, use Duplicate search. The $contains operator does work here — it matches a fragment of text inside the value, which makes it a practical approach for email: { "email": { "$contains": "@example.com" } }.

See also

• List leads
• Duplicate search
• Filtering syntax
• Batch
• Limits and optimization