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

Получить комплект шаблонов

Доступно начиная с модуля sign 26.1300.0. На старых коробочных установках метод может быть недоступен: платформа вернёт 422 METHOD_NOT_YET_AVAILABLE с error.release.

GET /v1/sign-b2e/template-folders/:id

Возвращает доступный для отправки комплект вместе с шаблонами. Нужны права чтения документов. Отсутствующий, недоступный или непригодный для отправки комплект даёт одинаковый отказ.

Скоупы: sign.b2e, crm.

Параметры пути

Параметр Тип Обяз. Описание
Параметрid Типstring Обяз.да ОписаниеИдентификатор комплекта из списка комплектов.

Примеры

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

Terminal
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/template-folders/7' \
  -H 'X-Api-Key: YOUR_API_KEY'

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

Terminal
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/template-folders/7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN'

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/template-folders/7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY"
  }
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/template-folders/7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеУспешность запроса.
Полеdata Типobject ОписаниеДанные операции.
Полеdata.id Типinteger ОписаниеИдентификатор объекта.
Полеdata.title Типstring ОписаниеНазвание объекта.
Полеdata.companyId Типinteger ОписаниеИдентификатор компании CRM.
Полеdata.companyName Типstring ОписаниеНазвание компании.
Полеdata.templateCount Типinteger ОписаниеКоличество шаблонов.
Полеdata.templates Типarray ОписаниеШаблоны комплекта.
Полеdata.templates[].uid Типstring ОписаниеUID шаблона.
Полеdata.templates[].title Типstring ОписаниеНазвание объекта.
Полеdata.templates[].companyId Типinteger | null ОписаниеИдентификатор компании CRM.
Полеdata.templates[].companyName Типstring | null ОписаниеНазвание компании.
Полеdata.templates[].regionDocumentType Типstring | null ОписаниеРегиональный тип документа.
Полеdata.templates[].providerCode Типstring | null ОписаниеСохранённый код провайдера; null, если неизвестен.
Полеmeta.redacted Типarray ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений.

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

Форма успешного ответа; данные зависят от портала и запроса.

JSON
{
  "success": true,
  "data": {
    "id": 7,
    "title": "VIBE-PROBE",
    "companyId": 7,
    "companyName": "Example Company",
    "templateCount": 0,
    "templates": []
  }
}

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

403 — ключу не выдан обязательный скоуп:

JSON
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sign.b2e' scope"
  }
}

Ошибки

HTTP Код Причина
HTTP400 КодINVALID_PARAMS ПричинаНеверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса.
HTTP401 КодTOKEN_MISSING ПричинаНет учётных данных соединения с Битрикс24.
HTTP403 КодSCOPE_DENIED ПричинаНе выдан один из обязательных скоупов.
HTTP422 КодBITRIX_ERROR ПричинаБитрикс24 отказал в операции; код в error.b24Code, текст в error.message.
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ПричинаМетода ещё нет на портале; выпуск в error.release.
HTTP404 КодSIGN_B2E_TEMPLATE_FOLDER_NOT_FOUND ПричинаКомплект отсутствует или недоступен для отправки. Нативный код сохраняется в error.code и error.b24Code.
HTTP404 КодENTITY_NOT_FOUND ПричинаБитрикс24 вернул общий отказ NOT_FOUND. Нативный код передаётся в error.b24Code.

Общие ошибки API.

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

Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.

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