Список реквизитов

GET /v1/requisites

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

Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей (до 5000). При limit > 50 Вайбкод автоматически запрашивает несколько страниц у Битрикс24
offset number 0 Пропустить N записей. При offset > 0 рекомендуется limit ≤ 500
select string — Выборка полей: ?select=id,rqName,rqInn
order object — Сортировка: ?order[sort]=asc или ?sort=-id
filter object — Фильтрация по полям GET /v1/requisites/fields.
Синтаксис фильтрации. Пример: ?filter[entityTypeId]=4&filter[entityId]=15

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisites?filter[entityTypeId]=4&filter[entityId]=15" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisites?filter[entityTypeId]=4&filter[entityId]=15', {
  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/requisites?filter[entityTypeId]=4&filter[entityId]=15', {
  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": [
    {
      "id": 42,
      "entityTypeId": 4,
      "entityId": 15,
      "presetId": 1,
      "name": "Основной реквизит",
      "active": true,
      "sort": 500,
      "code": null,
      "xmlId": null,
      "addressOnly": false,
      "createdAt": "2025-01-15T09:30:00+03:00",
      "updatedAt": "2026-03-20T14:00:00+03:00",
      "createdBy": 1,
      "modifyBy": 1,
      "rqName": "ООО «Ромашка»",
      "rqInn": "7701234567",
      "rqKpp": "770101001",
      "rqOgrn": "1027700123456",
      "rqOkpo": "12345678",
      "rqOkved": "62.01",
      "rqCompanyName": "Ромашка",
      "rqCompanyFullName": "Общество с ограниченной ответственностью «Ромашка»",
      "rqDirector": "Иванов Иван Иванович",
      "rqAccountant": "Петрова Анна Сергеевна",
      "rqVatPayer": false
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "Requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
400 INVALID_FILTER Ошибка в синтаксисе фильтра

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

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

Поля схемы — camelCase, пользовательские — в исходном регистре. Все поля схемы Вайбкод, в том числе поля международных шаблонов rqEdrpou, rqKbe, rqRegon, rqSiret, rqCnpj, возвращаются в camelCase. Фильтр и сортировка — по тому же имени. Пользовательские поля UF_CRM_* возвращаются в исходном регистре Битрикс24.

Пустые значения нормализованы. Битрикс24 возвращает "" для очищенных полей и null для никогда не заполненных. Вайбкод приводит их к null для string/number/date/datetime типов — клиенту достаточно проверки if (v) без дополнительных условий.

Сужайте выборку фильтром по владельцу. В портале могут быть десятки тысяч реквизитов. Для получения реквизитов конкретной компании или контакта передавайте entityTypeId + entityId.

Коды entityTypeId: 3 — контакт, 4 — компания. Для смарт-процессов и других сущностей CRM реквизиты не поддерживаются на уровне Битрикс24.

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

Ограничение offset. При offset ≥ 2500 Битрикс24 может вернуть INTERNAL_ERROR. Используйте limit ≤ 500 при больших offset.

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