#Получить реквизит

GET /v1/requisites/:id

Возвращает реквизит по ID со всеми полями, которые доступны в его пресете (пресет задаёт набор полей: наименование, ИНН/КПП/ОГРН, директор, бухгалтер и т. д.).

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID реквизита

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisites/42" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisites/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/requisites/42', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Реквизит:', data.rqName, '— ИНН', data.rqInn)

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

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

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект реквизита
data.id number Идентификатор реквизита
data.entityTypeId number Тип родительской сущности: 3 — контакт, 4 — компания
data.entityId number ID родительской сущности
data.presetId number ID пресета
data.name string Название реквизита в интерфейсе
data.active boolean Активен ли реквизит
data.sort number Порядок сортировки
data.createdAt / data.updatedAt datetime Даты создания и изменения (ISO 8601)
data.createdBy / data.modifyBy number | null ID создателя / последнего редактора
data.rqName / data.rqInn / data.rqKpp / data.rqOgrn string | null Основные реквизиты юрлица

Поля пресета, которые не заполнены, возвращаются как null. Полный список всех 60 полей — Поля реквизита.

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

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",
    "rqOktmo": null,
    "rqVatPayer": false,
    "rqCompanyName": "Ромашка",
    "rqCompanyFullName": "Общество с ограниченной ответственностью «Ромашка»",
    "rqDirector": "Иванов Иван Иванович",
    "rqAccountant": "Петрова Анна Сергеевна",
    "rqCeoName": null,
    "rqCeoWorkPos": null,
    "rqContact": null,
    "rqEmail": null,
    "rqPhone": null,
    "rqBaseDoc": "Устав"
  }
}

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

404 — реквизит не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The Requisite with ID '999999999' is not found"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Реквизит с таким ID не найден
403 ACCESS_DENIED Нет доступа к родительской сущности (контакту/компании)
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Набор полей зависит от пресета. Реквизит хранит только поля, которые определены в его пресете (presetId). Например, у пресета «ООО» будет rqCompanyName, rqCompanyFullName, rqDirector, а у пресета «Физическое лицо» — rqFirstName, rqLastName, rqSecondName и т. д. Поля пресета, которые не заполнены, возвращаются как null.

60 популярных полей — camelCase, международные — UPPER_SNAKE_CASE. Схема Вайбкод покрывает 60 российских и общих полей — они возвращаются в camelCase. Поля пресетов других стран (RQ_EDRPOU, RQ_KBE, RQ_REGON, RQ_SIRET, RQ_CNPJ и др.) и редкие служебные поля (RQ_USRLE, RQ_IFNS, UF_CRM_*) возвращаются в исходном UPPER_SNAKE_CASE.

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