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

Список комплектов шаблонов

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

POST /v1/sign-b2e/template-folders/tail

Возвращает комплекты, все шаблоны которых доступны для отправки владельцу ключа. Нужны права чтения документов. Продолжайте обход до hasMore=false, включая пустые промежуточные страницы.

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

Поля запроса (body)

Параметр Тип Обяз. Описание
Параметрcursor Типobject | null Обяз.нет ОписаниеКурсор из meta.cursor предыдущего ответа целиком. В первом запросе не передаётся; допустим null.
Параметрcursor.field Типstring Обяз.нет ОписаниеПоле курсора: id.
Параметрcursor.value Типinteger | string Обяз.нет ОписаниеПоследний просмотренный идентификатор; 0 в начале обхода.
Параметрcursor.order Типstring Обяз.нет ОписаниеНаправление ASC, регистр не важен.
Параметрcursor.limit Типinteger | string Обяз.нет ОписаниеПо умолчанию 50; минимум 1, значения выше 50 ядро уменьшает до 50.

Примеры

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

Terminal
curl -X POST 'https://vibecode.bitrix24.tech/v1/sign-b2e/template-folders/tail' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

Terminal
curl -X POST 'https://vibecode.bitrix24.tech/v1/sign-b2e/template-folders/tail' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/template-folders/tail', {
  "method": "POST",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});
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/tail', {
  "method": "POST",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеУспешность запроса.
Полеdata Типarray ОписаниеДанные операции.
Поле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.cursor Типobject ОписаниеКурсор для следующего запроса.
Полеmeta.hasMore Типboolean ОписаниеЕсть следующая страница, даже если data пуст.
Полеmeta.redacted Типarray ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений.

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

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

JSON
{
  "success": true,
  "data": [],
  "meta": {
    "cursor": {
      "field": "id",
      "value": "7",
      "order": "ASC",
      "limit": 50
    },
    "hasMore": false
  }
}

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

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.

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

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

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

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