## Список адресов

`GET /v1/addresses`

Возвращает список адресов CRM-сущностей с поддержкой фильтрации, сортировки и авто-пагинации. У адреса нет отдельного числового `id`: чтобы получить один адрес, используйте три значения — `typeId`, `entityTypeId` и `entityId`.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `select` | string | — | Поля через запятую: `typeId`, `entityTypeId`, `entityId`, `address1`, `address2`, `city`, `postalCode`, `region`, `province`, `country`, `countryCode`, `locAddrId`, `anchorTypeId`, `anchorId`. Принимаются и исходные имена Битрикс24 — `CITY` проецирует `city`. Значение `*` возвращает все поля. Без `select` приходит полная запись |
| `limit` | number | `50` | Количество записей (до 5000). При `limit > 50` Вайбкод автоматически запрашивает несколько страниц у Битрикс24 |
| `offset` | number | `0` | Пропустить N записей. При `offset ≥ 2500` рекомендуется `limit ≤ 500` |
| `sort` / `order` | string / object | — | Сортировка: `?sort=typeId` или `?order[typeId]=desc` |
| `filter` | object | — | Фильтрация по полям `GET /v1/addresses/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[entityTypeId]=8&filter[entityId]=42` |

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/addresses?filter[entityTypeId]=8&filter[entityId]=42" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/addresses?filter[entityTypeId]=8&filter[entityId]=42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/addresses?filter[entityTypeId]=8&filter[entityId]=42',
  {
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  }
)

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} адресов`)
```

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

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/addresses?filter[entityTypeId]=8&filter[entityId]=42',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

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

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

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

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

```json
{
  "success": true,
  "data": [
    {
      "typeId": 1,
      "entityTypeId": 3,
      "entityId": 9,
      "address1": null,
      "address2": null,
      "city": null,
      "postalCode": null,
      "region": null,
      "province": null,
      "country": null,
      "countryCode": null,
      "locAddrId": 0,
      "anchorTypeId": 3,
      "anchorId": 9
    },
    {
      "typeId": 1,
      "entityTypeId": 3,
      "entityId": 17,
      "address1": null,
      "address2": null,
      "city": null,
      "postalCode": null,
      "region": null,
      "province": null,
      "country": null,
      "countryCode": null,
      "locAddrId": 0,
      "anchorTypeId": 3,
      "anchorId": 17
    }
  ],
  "meta": {
    "total": 185,
    "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` | Ошибка в синтаксисе фильтра |
| 422 | `BITRIX_ERROR` | В `select` передано имя, которого нет в схеме адресов. Эта дверь передаёт имя дальше в Битрикс24, поэтому исход задаёт он: аккаунт, где такого поля нет, отклоняет весь вызов, и данные не приходят, а сообщение называет имя. Аккаунт, который имя принял, отвечает `200` и предупреждением `UNKNOWN_SELECT_FIELD` в `meta.warnings` — обрабатывайте оба исхода. Доступные имена — [Поля адреса](/docs/entities/addresses/fields) |

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

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

**У адреса нет отдельного числового `id`.** Каждый адрес определяется тремя значениями: `typeId` (тип адреса), `entityTypeId` (тип владельца) и `entityId` (ID владельца). Чтобы получить один адрес, используйте `GET /v1/addresses/:typeId/:entityTypeId/:entityId`.

**Составной ключ остаётся в сужённой записи.** При `select` поля `typeId`, `entityTypeId` и `entityId` приходят в ответе, даже если их не перечислили. Без них строку нельзя отличить от соседней и нельзя собрать путь запроса на изменение или удаление.

**Авто-пагинация.** При `limit > 50` Вайбкод автоматически запрашивает несколько страниц у Битрикс24 и возвращает все записи в одном ответе.

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

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