## Поиск компаний

`POST /v1/companies/search`

Поиск компаний по условиям в теле запроса. Принимает те же фильтры, что и список компаний, и рассчитан на составные условия и большие выборки.

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

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

## Примеры

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

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

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

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

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

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

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

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

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

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `data` | array | Массив компаний (поля — см. [Поля](/docs/entities/companies/fields)) |
| `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/company/details/<id>/
```

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

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

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "title": "ЗАО \"Ложки\"",
      "industry": "IT",
      "assignedById": 1
    }
  ],
  "meta": {
    "total": 74,
    "hasMore": true,
    "durationMs": 537
  }
}
```

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

```json
{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 8,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 131,
    "batchWaves": 3,
    "durationMs": 1494
  }
}
```

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

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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` больше нуля вместе с фильтром по диапазону дат шире 14 дней. Два разных алгоритма выдачи дают несогласованные результаты, поэтому запрос отклоняется. Возьмите всё одним запросом с `limit` до 5000, либо передайте `autoWindow: false` с сортировкой по `id`, либо режьте диапазон дат на части сами |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

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

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

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

**Фильтр по телефону подходит не для всякого поиска.** Значение без оператора сравнивается со всей сохранённой строкой: компания с номером `+7 (999) 123-45-67` найдётся по этой же строке и не найдётся по `79991234567`, потому что плюс, пробелы, скобки и дефисы — часть значения. Вдобавок фильтр видит только первый номер записи: если записаны рабочий и мобильный, по мобильному он вернёт пустой список. Чтобы найти компанию по номеру телефона в любом написании и по любому из его номеров, используйте [Поиск дубликатов](/docs/duplicates). Оператор `$contains` при этом работает — он ищет кусок текста внутри значения, это рабочий способ для почты: `{ "email": { "$contains": "@example.com" } }`.

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

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