## Поиск элементов смарт-процесса

`POST /v1/items/:entityTypeId/search`

Расширенный поиск элементов с фильтрацией, сортировкой и авто-пагинацией. Поддерживает до 5000 записей.

## Поля запроса (body)

| Параметр | Тип | Описание |
|----------|-----|---------|
| `filter` | object | Фильтрация по полям `GET /v1/items/:entityTypeId/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{ "filter": { "assignedById": 1 } }` |
| `sort` | string | Сортировка. Префикс `-` — по убыванию |
| `limit` | number | Количество записей (по умолчанию 50, макс. 5000) |
| `offset` | number | Пропустить N записей. Вместе с фильтром по диапазону дат шире 14 дней отклоняется — см. `UNSTABLE_OFFSET_PAGINATION` в разделе «Ошибки» |
| `select` | array | Список возвращаемых полей |
| `autoWindow` | boolean | Разбивать выборку по недельным окнам при фильтре по диапазону дат шире 14 дней. По умолчанию `true`. `false` отключает разбиение |

### Синтаксис фильтров

Поддерживаются три формата:

```json
{ "filter": { ">=opportunity": 100000 } }
{ "filter": { "opportunity": { "$gte": 100000 } } }
{ "filter": { "opportunity": { ">=": 100000 } } }
```

## Примеры

В примерах `entityTypeId = 156` — замените на ID вашего смарт-процесса.

### curl — личный ключ

```bash
curl -X POST https://vibecode.bitrix24.tech/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-приложение

```bash
curl -X POST https://vibecode.bitrix24.tech/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 — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/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(`Найдено: ${meta.total}`)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/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()
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `data` | array | Массив элементов |
| `meta.total` | number | Сколько записей подошло под фильтр |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |
| `meta.nextAfterId` | string | Идентификатор последней отданной записи. Приходит при сортировке строго по `id` по возрастанию, пока `hasMore` равен `true`. Передайте его обратно в фильтр `>id` — это дешёвая замена растущему `offset` |
| `meta.durationMs` | number | Длительность запроса в миллисекундах |
| `meta.autoWindowed` | boolean | `true`, если выборка была разбита по временны́м окнам |
| `meta.windowCount` | number | Число окон. Приходит при `autoWindowed: true` |
| `meta.batchWaves` | number | Число волн параллельных запросов. Приходит при `autoWindowed: true` |

Поля `meta` лежат рядом с `data`, а не внутри него. Обходить страницы нужно по `meta.hasMore`: длина `data`, равная `limit`, последней страницы не исключает.

URL карточки любого элемента из массива `data` — его `id`:

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

`<entityTypeId>` — ID типа смарт-процесса (тот же, что в пути запроса). `<portal>` — домен портала. Если смарт-процесс вынесен в отдельный раздел портала, Битрикс24 откроет карточку по соответствующему пути. Доступ ограничен правами сотрудника в Битрикс24.

## Пример ответа

```json
{
  "success": true,
  "data": [
    {
      "id": 783,
      "title": "Договор на поставку",
      "stageId": "DT156_41:NEW",
      "opportunity": 500000
    }
  ],
  "meta": { "total": 5, "hasMore": false, "durationMs": 320 }
}
```

С фильтром по диапазону дат шире 14 дней в `meta` дополнительно приходят `autoWindowed`, `windowCount` и `batchWaves`:

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

## Пример ответа при ошибке

403 — нет скоупа:

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 400 | `INVALID_DYNAMIC_PARAM` | `entityTypeId` не является положительным целым или является зарезервированным (1, 2, 3, 4, 7, 31) |
| 400 | `UNKNOWN_FILTER_FIELD` | Поле фильтра не существует у сущности — сообщение перечисляет доступные поля |
| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` больше нуля вместе с фильтром по диапазону дат шире 14 дней. Два разных алгоритма выдачи дают несогласованные результаты, поэтому запрос отклоняется. Возьмите всё одним запросом с `limit` до 5000, либо передайте `autoWindow: false` с сортировкой по `id`, либо режьте диапазон дат на части сами |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Разбиение по временны́м окнам.** Фильтр по диапазону дат шире 14 дней автоматически разбивается на недельные окна, которые выполняются параллельными волнами — так выборка обходит потолок в 5000 записей на один вызов. В `meta` тогда приходят `autoWindowed: true`, число окон `windowCount` и число волн `batchWaves`. Отключает разбиение параметр `autoWindow: false`. При активном разбиении `offset` больше нуля отклоняется с `UNSTABLE_OFFSET_PAGINATION`.

## Смотрите также

- [Список элементов](/docs/entities/items/list)
- [Поля элемента](/docs/entities/items/fields)
- [Batch](/docs/batch)
- [Смарт-процессы](/docs/entities/smart-processes)
- [Entity API](/docs/entity-api)