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

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

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

GET /v1/sign-b2e/templates

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

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

Параметры запроса (query)

Параметр Тип Обяз. Описание
Параметрlimit Типinteger | string Обяз.нет ОписаниеПо умолчанию 50; положительное число. Эффективный максимум страницы — 50: большее значение ядро уменьшает до 50. Значение page рассчитывается по ограниченному размеру страницы.
Параметрoffset Типinteger | string Обяз.нет ОписаниеСмещение от начала списка; по умолчанию 0.
Параметрpage Типinteger | string Обяз.нет ОписаниеНомер страницы. Смещение рассчитывается с учётом ограниченного размера страницы.

Примеры

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

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

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

Terminal
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/templates' \
  -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/templates', {
  "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/templates', {
  "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 Типarray ОписаниеДанные операции.
Полеdata[].uid Типstring ОписаниеUID шаблона.
Полеdata[].title Типstring ОписаниеНазвание объекта.
Полеdata[].companyId Типinteger | null ОписаниеИдентификатор компании CRM.
Полеdata[].companyName Типstring | null ОписаниеНазвание компании.
Полеdata[].regionDocumentType Типstring | null ОписаниеРегиональный тип документа.
Полеdata[].providerCode Типstring | null ОписаниеСохранённый код провайдера; null, если неизвестен.
Полеmeta.redacted Типarray ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений.

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

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

JSON
{
  "success": true,
  "data": []
}

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

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; ссылки с учётными данными скрываются.

Максимум 50 элементов, итогового количества нет. Используются limit/offset или page; page пересчитывает смещение с учётом ограниченного limit.

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