Для AI-агентов: markdown этой страницы — /docs-content/entities/requisite-presets/get.md индекс документации — /llms.txt

Получить шаблон реквизитов

GET /v1/requisite-presets/:id

Возвращает шаблон реквизитов по ID со всеми системными полями.

Параметры

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

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets/1" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/1', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Шаблон:', data.name, '— страна', data.countryId)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/1', {
  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 Тип сущности — всегда 8, реквизит
data.countryId number Идентификатор страны набора полей; 1 — Россия
data.name string Название шаблона
data.active boolean Активен ли шаблон
data.sort number Порядок сортировки
data.xmlId string | null Внешний идентификатор для синхронизации
data.createdAt datetime Дата создания (ISO 8601)
data.updatedAt datetime | null Дата последнего изменения; null, если шаблон не изменялся
data.createdBy number Идентификатор создателя; 0 — создано системой
data.modifyBy number | null Идентификатор последнего редактора; null, если шаблон не изменялся

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

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "entityTypeId": 8,
    "countryId": 1,
    "name": "Организация",
    "active": true,
    "sort": 510,
    "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#",
    "createdAt": "2020-04-20T10:47:23.000Z",
    "updatedAt": "2021-08-13T14:34:26.000Z",
    "createdBy": 0,
    "modifyBy": 1
  }
}

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

404 — шаблон не найден:

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

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Шаблон с таким ID не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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