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

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

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

Параметры

Параметр Тип Обяз. Описание
typeId (path) number да Тип адреса: 1 — регистрационный, 4 — первичный, 6 — почтовый, 8 — доставки, 9 — фактический, 11 — бенефициар, 13 — склад
entityTypeId (path) number да Тип владельца: 8 — реквизит, 3 — контакт, 4 — компания, 1 — лид
entityId (path) number да ID владельца адреса. Для реквизита — ID из GET /v1/requisites

Примеры

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

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

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

Terminal 
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 сущности, к которой привязан адрес (только чтение)

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

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 — Ошибки.

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