## Получить адрес

`GET /v1/addresses/:typeId/:entityTypeId/:entityId`

Возвращает один адрес по составному ключу из трёх параметров: тип адреса, тип владельца и ID владельца.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `typeId` (path) | number | да | Тип адреса, коды с `1` по `12`: `1` — фактический (в англоязычном интерфейсе Битрикс24 — Street address), `2` — второй, `3` — третий, `4` — адрес регистрации, `5` — рабочий, `6` — юридический, `7` — дополнительный, `8` — для корреспонденции, `9` — бенефициара, `10` — адрес банка, `11` — доставки, `12` — платёжный. Какие из них доступны порталу, зависит от его страновой зоны, поэтому часть кодов конкретный портал может не вернуть никогда |
| `entityTypeId` (path) | number | да | Тип владельца: `8` — реквизит, `3` — контакт, `4` — компания, `1` — лид |
| `entityId` (path) | number | да | ID владельца адреса. Для реквизита — ID из `GET /v1/requisites` |
| `select` (query) | string | нет | Поля через запятую: `city`, `postalCode` и остальные из таблицы ответа ниже. Принимаются и исходные имена Битрикс24 — `CITY` проецирует `city`. Значение `*` возвращает все поля. Без `select` приходит полная запись. Составной ключ `typeId`, `entityTypeId`, `entityId` приходит всегда, даже если его не перечислили |

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/addresses/1/3/9" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/addresses/1/3/9" \
  -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/1/3/9', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Город:', data.city, 'Индекс:', data.postalCode)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/1/3/9', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | object | Объект адреса |
| `data.typeId` | number | Тип адреса |
| `data.entityTypeId` | number | Тип владельца |
| `data.entityId` | number | ID владельца |
| `data.address1` | string \| null | Улица, дом, корпус, строение |
| `data.address2` | string \| null | Квартира, офис |
| `data.city` | string \| null | Город |
| `data.postalCode` | string \| null | Почтовый индекс |
| `data.region` | string \| null | Район |
| `data.province` | string \| null | Область |
| `data.country` | string \| null | Страна |
| `data.countryCode` | string \| null | Код страны |
| `data.locAddrId` | number | Идентификатор адреса местоположения |
| `data.anchorTypeId` | number | Тип сущности, к которой привязан адрес (только чтение) |
| `data.anchorId` | number | ID сущности, к которой привязан адрес (только чтение) |
| `meta.warnings` | array | Приходит только при разборе `select`. Каждое предупреждение — объект с полями `code`, `field` и `message`. Имя, которого нет в схеме адресов, приходит с кодом `UNKNOWN_SELECT_FIELD` |

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

```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
  }
}
```

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

404 — адрес не найден:

```json
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Address (typeId=1, entityTypeId=3, entityId=99999999) not found"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 404 | `NOT_FOUND` | Адрес с таким составным ключом не найден |
| 400 | `INVALID_COMPOSITE_KEY` | Один из параметров пути не является положительным целым числом |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

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

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

**Незнакомое имя в `select` здесь всегда предупреждение, а в списке и поиске исход задаёт аккаунт.** Получение по составному ключу читает запись целиком и отбирает поля на стороне Вайбкод, поэтому имя, которого нет в схеме адресов, возвращается предупреждением `UNKNOWN_SELECT_FIELD` в `meta.warnings`, а сама запись приходит. [Список](/docs/entities/addresses/list) и [поиск](/docs/entities/addresses/search) передают перечисленные имена дальше в Битрикс24, и там исход задаёт аккаунт: не знающий такого поля отклоняет весь запрос с `422 BITRIX_ERROR`. Имя `id` подчиняется тому же правилу: на этой странице оно возвращает составной ключ, а на списке и поиске уходит на ту же проверку.

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

- [Поля адреса](/docs/entities/addresses/fields)
- [Список адресов](/docs/entities/addresses/list)
- [Обновить адрес](/docs/entities/addresses/update)
- [Реквизиты](/docs/entities/requisites)
- [Лимиты и оптимизация](/docs/optimization)