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

Search smart process items

POST /v1/items/:entityTypeId/search

Advanced item search with filtering, sorting, and auto-pagination. Supports up to 5000 records.

Request fields (body)

Parameter Type Description
filter object Filtering by fields from GET /v1/items/:entityTypeId/fields.
Filtering syntax. Example: { "filter": { "assignedById": 1 } }
sort string Sorting. The - prefix means descending
limit number Number of records (default 50, max 5000)
offset number Skip N records. Together with a date-range filter wider than 14 days it is rejected — see UNSTABLE_OFFSET_PAGINATION in the "Errors" section
select array List of returned fields
autoWindow boolean Split the result set into weekly windows when filtering by a date range wider than 14 days. Defaults to true. false disables splitting

Filter syntax

Three formats are supported:

JSON 
{ "filter": { ">=opportunity": 100000 } }
{ "filter": { "opportunity": { "$gte": 100000 } } }
{ "filter": { "opportunity": { ">=": 100000 } } }

Examples

In the examples entityTypeId = 156 — replace with your smart process ID.

curl — personal key

Terminal 
curl -X POST https://vibecode.bitrix24.com/v1/items/156/search \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "assignedById": 1,
      "stageId": "DT156_41:NEW"
    },
    "select": ["id", "title", "opportunity", "stageId"],
    "sort": "-createdTime",
    "limit": 100
  }'

curl — OAuth application

Terminal 
curl -X POST https://vibecode.bitrix24.com/v1/items/156/search \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "assignedById": 1,
      "stageId": "DT156_41:NEW"
    },
    "select": ["id", "title", "opportunity", "stageId"],
    "sort": "-createdTime",
    "limit": 100
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/items/156/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { assignedById: 1, stageId: 'DT156_41:NEW' },
    select: ['id', 'title', 'opportunity', 'stageId'],
    sort: '-createdTime',
    limit: 100,
  }),
})

const { success, data, meta } = await res.json()
console.log(`Found: ${meta.total}`)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/items/156/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { assignedById: 1, stageId: 'DT156_41:NEW' },
    select: ['id', 'title', 'opportunity', 'stageId'],
    sort: '-createdTime',
    limit: 100,
  }),
})

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

Response fields

Field Type Description
data array Array of items
meta.total number How many records matched the filter
meta.hasMore boolean Whether there is a next page
meta.durationMs number Request duration in milliseconds
meta.autoWindowed boolean true if the result set was split into time windows
meta.windowCount number Number of windows. Present with autoWindowed: true
meta.batchWaves number Number of parallel request waves. Present with autoWindowed: true

The meta fields sit next to data, not inside it. Pages must be walked by meta.hasMore: a data length equal to limit does not rule out the last page.

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

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

<entityTypeId> — the smart process type ID (the same as in the request path). <portal> — the Bitrix24 account domain. If the smart process is placed in a separate section of your Bitrix24 account, Bitrix24 opens the card at the corresponding path. Access is restricted by the employee's permissions in Bitrix24.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 783,
      "title": "Supply contract",
      "stageId": "DT156_41:NEW",
      "opportunity": 500000
    }
  ],
  "meta": { "total": 5, "hasMore": false, "durationMs": 320 }
}

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

JSON 
{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 8,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 339,
    "batchWaves": 7,
    "durationMs": 15817
  }
}

Error response example

403 — no scope:

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

Errors

HTTP Code Description
403 SCOPE_DENIED The API key does not have the crm scope
401 TOKEN_MISSING The API key has no configured tokens
400 INVALID_DYNAMIC_PARAM entityTypeId is not a positive integer or is reserved (1, 2, 3, 4, 7, 31)
400 UNKNOWN_FILTER_FIELD The filter field does not exist on the entity — the message lists the available fields
400 UNSTABLE_OFFSET_PAGINATION offset greater than zero together with a date-range filter wider than 14 days. Two different retrieval algorithms produce inconsistent results, so the request is rejected. Take everything in a single request with limit up to 5000, or pass autoWindow: false with sorting by id, or split the date range into parts yourself

Full list of common API errors — 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.

See also