## Поиск адресов

`POST /v1/addresses/search`

Поиск адресов с фильтрами и авто-пагинацией. Аналогичен `GET /v1/addresses`, но параметры передаются в теле запроса — подходит для сложных фильтров с большим количеством условий и для программной сборки запросов.

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

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `filter` | object | — | Фильтрация по полям `GET /v1/addresses/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{ "entityTypeId": 8, "entityId": 42 }` |
| `select` | array | — | Имена полей: `["city", "postalCode"]`. Принимаются и исходные имена Битрикс24 — `CITY` проецирует `city`. Значение `["*"]` возвращает все поля. Рядом с `"*"` незнакомое имя поиск не отклоняет — приходит `200` и предупреждение `UNKNOWN_SELECT_FIELD` в `meta.warnings`, а поля в записях нет. Без `select` приходит полная запись. Составной ключ `typeId`, `entityTypeId`, `entityId` приходит всегда |
| `limit` | number | `50` | Количество записей (до 5000) |
| `offset` | number | `0` | Пропустить N записей |
| `sort` | object | — | Сортировка: `{ "typeId": "asc" }` |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/addresses/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityTypeId": 1, "city": "Пермь" },
    "limit": 20
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/addresses/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityTypeId": 1, "city": "Пермь" },
    "limit": 20
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityTypeId: 1, city: 'Пермь' },
    limit: 20,
  }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityTypeId: 1, city: 'Пермь' },
    limit: 20,
  }),
})

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

### Другие сценарии

Все адреса одного реквизита:

```json
{
  "filter": { "entityTypeId": 8, "entityId": 42 }
}
```

Адреса определённого типа у лида:

```json
{
  "filter": { "entityTypeId": 1, "entityId": 1000755, "typeId": 1 }
}
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив адресов (все поля — см. [Поля адреса](/docs/entities/addresses/fields)) |
| `meta.total` | number | Общее количество записей, соответствующих фильтру |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |

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

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

```json
{
  "success": true,
  "data": [
    {
      "typeId": 1,
      "entityTypeId": 1,
      "entityId": 1000755,
      "address1": "Монастырская улица, 5",
      "address2": "Вокзал Пермь I",
      "city": "Пермь",
      "postalCode": "614000",
      "region": "Пермский городской округ",
      "province": "Пермский край",
      "country": "Россия",
      "countryCode": null,
      "locAddrId": 483,
      "anchorTypeId": 1,
      "anchorId": 1000755
    },
    {
      "typeId": 1,
      "entityTypeId": 1,
      "entityId": 1000759,
      "address1": "улица Куйбышева, 97",
      "address2": "каб. 5",
      "city": "Пермь",
      "postalCode": "614045",
      "region": "Пермский городской округ",
      "province": "Пермский край",
      "country": "Россия",
      "countryCode": null,
      "locAddrId": 491,
      "anchorTypeId": 1,
      "anchorId": 1000759
    }
  ],
  "meta": {
    "total": 107,
    "hasMore": true
  }
}
```

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

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_FILTER` | Ошибка в синтаксисе фильтра |
| 400 | `UNKNOWN_SELECT_FIELD` | В `select` передано имя, которого нет в схеме адресов. Поиск отклоняется до вызова Битрикс24, и `message` перечисляет допустимые имена после слова `Available`. Доступные имена — [Поля адреса](/docs/entities/addresses/fields) |
| 422 | `BITRIX_ERROR` | В `select` передано `id`. Схема адресов это имя принимает, Битрикс24 его не знает, поэтому весь поиск отклоняется с текстом `Unknown field definition`. Составной ключ отдаёт [получение одного адреса](/docs/entities/addresses/get) |

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

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

**Имена полей в фильтре — camelCase.** Передавайте `typeId`, `entityTypeId`, `entityId`, `city`, `postalCode`, `countryCode` — те же имена, что отдаёт схема `GET /v1/addresses/fields`.

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

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