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

GET /v1/addresses

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

Параметры

Параметр Тип По умолч. Описание
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.
Синтаксис фильтрации. Пример: ?filter[entityTypeId]=8&filter[entityId]=42

Примеры

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

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

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

Terminal 
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 Массив адресов (все поля — см. Поля адреса)
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 Ошибка в синтаксисе фильтра

Полный список общих ошибок API — Ошибки.

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

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

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

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