## Поиск сотрудников

`POST /v1/users/search`

Поиск сотрудников с фильтрами в теле запроса и автопагинацией. Аналогичен [`GET /v1/users`](/docs/entities/users/list), но через POST — удобнее для сложных запросов и больших массивов значений в фильтре.

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

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

Поля `UF_*` сохраняют сквозную передачу только для одной страницы Битрикс24: `limit ≤ 50`, `offset = 0` и без автоматического разбиения по датам. Вайбкод передаёт такое поле как есть, но не гарантирует, что конкретный портал применит порядок. При `limit > 50`, `offset > 0` или автоматическом разбиении по датам Вайбкод заменяет сортировку `UF_*` на `id` по возрастанию и добавляет одно предупреждение `SORT_FALLBACK_TO_ID` с полем `sort` в `meta.warnings`. Такое же предупреждение приходит при нескольких распознанных полях сортировки. Сочетание `offset > 0` с автоматическим разбиением по датам по-прежнему возвращает `UNSTABLE_OFFSET_PAGINATION` без успешного ответа.

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/users/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true },
    "limit": 10
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/users/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true },
    "limit": 10
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { active: true },
    limit: 10,
  }),
})

const { success, data } = await res.json()
console.log('Найдено:', data.length)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { active: true },
    limit: 10,
  }),
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив сотрудников. Каждый элемент содержит все поля — см. [Поля сотрудника](/docs/entities/users/fields) |
| `meta.total` | number | Сколько записей подошло под фильтр |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |
| `meta.durationMs` | number | Длительность запроса в миллисекундах |
| `meta.autoWindowed` | boolean | `true`, если выборка была разбита по временны́м окнам |
| `meta.windowCount` | number | Число окон. Приходит при `autoWindowed: true` |
| `meta.batchWaves` | number | Число волн параллельных запросов. Приходит при `autoWindowed: true` |
| `meta.warnings` | array | Предупреждения. Поле отсутствует, если предупреждений нет |
| `meta.warnings[].code` | string | Машинный код предупреждения. `SORT_FALLBACK_TO_ID` означает замену запрошенной сортировки на `id` по возрастанию |
| `meta.warnings[].field` | string | Поле запроса, к которому относится предупреждение. Для `SORT_FALLBACK_TO_ID` — `sort` |
| `meta.warnings[].message` | string | Пояснение предупреждения |

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

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

```
https://<portal>.bitrix24.ru/company/personal/user/<id>/
```

`<portal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "active": true,
      "name": "Мария",
      "lastName": null,
      "email": "maria@example.com",
      "departmentId": [1, 107, 47]
    },
    {
      "id": 29,
      "active": true,
      "name": "Иван",
      "lastName": "Петров",
      "email": "ivan.petrov@example.com",
      "departmentId": [1]
    }
  ],
  "meta": {
    "total": 59,
    "hasMore": true,
    "durationMs": 186
  }
}
```

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

```json
{
  "success": true,
  "data": [],
  "meta": {
    "total": 0,
    "hasMore": false,
    "autoWindowed": true,
    "windowCount": 131,
    "batchWaves": 3,
    "durationMs": 1189
  }
}
```

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

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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_FILTER_FIELD` | Фильтр по несуществующему полю — список полей в `GET /v1/users/fields` |
| 400 | `UNKNOWN_SORT_FIELD` | Одиночное обычное поле сортировки отличается от `id` — в том числе объявленные `isOnline` и `isAdmin`. Несколько распознанных полей вместо этого дают fallback на `id` по возрастанию с `SORT_FALLBACK_TO_ID`. При ошибке одиночного поля запрос не уходит в Битрикс24. |
| 400 | `INVALID_SORT_FIELD` | Имя поля сортировки имеет небезопасную или некорректную форму |
| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` больше нуля вместе с фильтром по диапазону дат шире 14 дней. Два разных алгоритма выдачи дают несогласованные результаты, поэтому запрос отклоняется. Возьмите всё одним запросом с `limit` до 5000, либо передайте `autoWindow: false` — тогда выборка идёт обычной постраничной навигацией Битрикс24, либо режьте диапазон дат на части сами |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `user` |
| 429 | `RATE_LIMITED` | Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке `x-ratelimit-limit` (потолок делится на реплики). Повторите после срока из заголовка `Retry-After` |

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

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

**Сортировка и разбиение по временны́м окнам.** Вайбкод гарантирует порядок сотрудников только по `id`. Значения `id` и `-id` сохраняют запрошенное направление и не добавляют предупреждение. Одностраничный `UF_*` сохраняет сквозную передачу для обратной совместимости. При нескольких распознанных полях или при многостраничной, смещённой либо оконной сортировке `UF_*` запрос выполняется с порядком `id` по возрастанию и одним предупреждением `SORT_FALLBACK_TO_ID`. Одиночное обычное поле не по `id` по-прежнему возвращает `UNKNOWN_SORT_FIELD`. Фильтр по диапазону дат шире 14 дней автоматически разбивается на недельные окна, которые выполняются параллельными волнами — так выборка обходит потолок в 5000 записей на один вызов. В `meta` тогда приходят `autoWindowed: true`, число окон `windowCount` и число волн `batchWaves`. Отключает разбиение параметр `autoWindow: false`. При активном разбиении `offset` больше нуля отклоняется с `UNSTABLE_OFFSET_PAGINATION`. Порядок по `id` применяется внутри каждого окна, но объединённый результат остаётся хронологическим и не пересортировывается глобально. Ошибка Битрикс24 остаётся ошибкой ответа.

**Семантика `filter[active]: false`.** Возвращает всех сотрудников, а не только деактивированных — Битрикс24 интерпретирует `ACTIVE = "Y"` как «исключить деактивированных», а другие значения как «без фильтра по статусу». Чтобы получить только деактивированных, делайте отдельную фильтрацию на стороне клиента по полю `active`.

**Когда использовать search вместо list.** POST-search удобнее для длинных списков значений в фильтре (`{ "id": [1, 5, 12, 27, 99] }`) — query-строка GET-запроса имеет ограничения на длину, а body POST — нет. Для коротких фильтров обе формы эквивалентны.

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

- [Список сотрудников](/docs/entities/users/list)
- [Поля сотрудника](/docs/entities/users/fields)
- [Синтаксис фильтрации](/docs/filtering)
- [Batch](/docs/batch)
- [Лимиты и оптимизация](/docs/optimization)