Получить список шаблонов documentgenerator.template.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: documentgenerator

Кто может выполнять метод: пользователь с правом на изменение шаблонов генератора документов

Метод documentgenerator.template.list возвращает список шаблонов по фильтру.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

select
array

Массив полей, которые нужно вернуть. По умолчанию — ["*"].

Для field_N используйте поля из таблицы полей.

Чтобы получить коды доступа и провайдеры, добавьте в select поля users и providers

order
object

Объект для сортировки шаблонов в формате {"field_1":"value_1", ... "field_N":"value_N"}.

Направление сортировки может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

Для field_N используйте поля из таблицы полей.

filter
object

Объект для фильтрации шаблонов в формате {"field_1":"value_1", ... "field_N":"value_N"}.

Для field_N используйте поля из таблицы полей.

К ключам field_n можно добавить префикс, уточняющий работу фильтра. Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

По умолчанию применяется фильтр isDeleted = "N"

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N — 1) * 50, где N — номер нужной страницы

Поля для select, order, filter

Название
тип

Описание

id
integer

Идентификатор шаблона

active
char

Активность шаблона. Возможные значения:

  • Y — активен
  • N — не активен

name
string

Название шаблона

code
string

Символьный код шаблона

region
string

Регион шаблона

sort
integer

Индекс сортировки

createTime
datetime

Дата и время создания

updateTime
datetime

Дата и время обновления

numeratorId
integer

Идентификатор нумератора

withStamps
char

Использование печатей и подписей. Возможные значения:

  • Y — да
  • N — нет

users
array

Коды доступа к шаблону. Только для select

providers
array

Провайдеры данных шаблона. Только для select

Примеры кода

Как использовать примеры в документации

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "select": [
      "*",
      "users",
      "providers"
    ],
    "order": {
      "id": "desc"
    },
    "filter": {
      "region": "ru",
      "active": "Y",
      ">=createTime": "2026-03-18T00:00:00+03:00"
    },
    "start": 0
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.list
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "select": [
      "*",
      "users",
      "providers"
    ],
    "order": {
      "id": "desc"
    },
    "filter": {
      "region": "ru",
      "active": "Y",
      ">=createTime": "2026-03-18T00:00:00+03:00"
    },
    "start": 0,
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/documentgenerator.template.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type TemplateItem = {
  id: string
  active: string
  name: string
  code: string
  region: string
  sort: string
  createTime: ISODate | null
  updateTime: ISODate | null
  createdBy: string
  updatedBy: string
  moduleId: string
  fileId: string
  bodyType: string
  numeratorId: string
  withStamps: string
  productsTableVariant: string
  isDeleted: string
  isDefault: string
  download: string
  downloadMachine: string
  users?: string[]
  providers?: string[]
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type TemplateListResult = {
  templates: Record<string, TemplateItem>
}

try {
  // documentgenerator.template.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<TemplateListResult>({
    method: 'documentgenerator.template.list',
    params: {
      select: ['*', 'users', 'providers'],
      order: {
        id: 'desc',
      },
      filter: {
        region: 'ru',
        active: 'Y',
        '>=createTime': '2026-03-18T00:00:00+03:00',
      },
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Templates count:', Object.keys(result.templates).length, result.templates)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listTemplates() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // documentgenerator.template.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'documentgenerator.template.list',
        params: {
          select: ['*', 'users', 'providers'],
          order: {
            id: 'desc',
          },
          filter: {
            region: 'ru',
            active: 'Y',
            '>=createTime': '2026-03-18T00:00:00+03:00',
          },
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Templates count:', Object.keys(result.templates).length, result.templates)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listTemplates)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.documentgenerator.template.list(
        select=[
            "*",
            "users",
            "providers",
        ],
        order={
            "id": "desc",
        },
        filter={
            "region": "ru",
            "active": "Y",
            ">=createTime": "2026-03-18T00:00:00+03:00",
        },
        start=0,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service->core->call(
        'documentgenerator.template.list',
        [
            'select' => ['*', 'users', 'providers'],
            'order' => [
                'id' => 'desc'
            ],
            'filter' => [
                'region' => 'ru',
                'active' => 'Y',
                '>=createTime' => '2026-03-18T00:00:00+03:00'
            ],
            'start' => 0,
        ]
    );

    $result = $response->getResponseData()->getResult();
    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    'documentgenerator.template.list',
    {
        select: ['*', 'users', 'providers'],
        order: {
            id: 'desc'
        },
        filter: {
            region: 'ru',
            active: 'Y',
            '>=createTime': '2026-03-18T00:00:00+03:00'
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());

            if (result.more())
            {
                result.next();
            }
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'documentgenerator.template.list',
    [
        'select' => ['*', 'users', 'providers'],
        'order' => [
            'id' => 'desc'
        ],
        'filter' => [
            'region' => 'ru',
            'active' => 'Y',
            '>=createTime' => '2026-03-18T00:00:00+03:00'
        ],
        'start' => 0,
    ]
);

print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.template.list", b24.Params{
	"select": []string{"*", "users", "providers"},
	"order": b24.Params{
		"id": "desc",
	},
	"filter": b24.Params{
		"region":       "ru",
		"active":       "Y",
		">=createTime": "2026-03-18T00:00:00+03:00",
	},
	"start": 0,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("documentgenerator.template.list: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "templates": {
            "57": {
                "id": "57",
                "active": "Y",
                "name": "SUPPLY_CONTRACT_NEW Template",
                "code": "REST_TEMPLATE",
                "region": "ru",
                "sort": "700",
                "createTime": "2026-03-23T16:51:25+03:00",
                "updateTime": "2026-03-23T17:26:39+03:00",
                "createdBy": "503",
                "updatedBy": "503",
                "moduleId": "rest",
                "fileId": "5641",
                "bodyType": "Bitrix\\DocumentGenerator\\Body\\Docx",
                "numeratorId": "3",
                "withStamps": "N",
                "productsTableVariant": "",
                "isDeleted": "N",
                "isDefault": "N",
                "download": "/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=57",
                "providers": [
                    "bitrix\\documentgenerator\\dataprovider\\rest"
                ],
                "users": [
                    "U503"
                ],
                "downloadMachine": "https://mysite.ru/rest/documentgenerator.api.template.download.json?auth=3f5cc2690000071b00000844000001f7f0f107506cefda4aa5b9d0dc80371e7f0f7e26&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZTSVRFX0lEPXMxJmlkPTU3Jl89RFB3MHZYN1A3RXdiMm5EenY2VFYyc1Vkb0hPejA3SlM%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZHxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzUwWlcxd2JHRjBaUzVrYjNkdWJHOWhaQ1pUU1ZSRlgwbEVQWE14Sm1sa1BUVTNKbDg5UkZCM01IWllOMUEzUlhkaU1tNUVlblkyVkZZeWMxVmtiMGhQZWpBM1NsTT18M2Y1Y2MyNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDc1MDZjZWZkYTRhYTViOWQwZGM4MDM3MWU3ZjBmN2UyNiI%3D.XuC83kQJE21vRoqv1%2FgdT8OiYq4JdpiSLxumy%2F1UcB0%3D"
            },
            "53": {
                "id": "53", // описание следующего шаблона
                ...
            },
            "51": {
                "id": "51", // описание следующего шаблона
                ...
            }
        }
    },
    "total": 3,
    "time": {
        "start": 1774341679,
        "finish": 1774341679.641056,
        "duration": 0.6410560607910156,
        "processing": 0,
        "date_start": "2026-03-24T11:41:19+03:00",
        "date_finish": "2026-03-24T11:41:19+03:00",
        "operating_reset_at": 1774342279,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа (подробное описание)

total
integer

Общее количество шаблонов в списке

time
time

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

templates
object

Объект шаблонов, где ключом выступает id, а значением — данные шаблона (подробное описание)

Элемент объекта templates

Название
тип

Описание

id
string

Идентификатор шаблона

active
char

Активность шаблона. Возможные значения:

  • Y — активен
  • N — не активен

name
string

Название шаблона

code
string

Символьный код шаблона

region
string

Регион шаблона

sort
string

Индекс сортировки

createTime
datetime

Дата и время создания

updateTime
datetime

Дата и время обновления

createdBy
string

Идентификатор пользователя, который создал шаблон

updatedBy
string

Идентификатор пользователя, который обновил шаблон

moduleId
string

Идентификатор модуля

fileId
string

Идентификатор файла шаблона

bodyType
string

Класс типа тела шаблона

numeratorId
string

Идентификатор нумератора

withStamps
char

Использование печатей и подписей. Возможные значения:

  • Y — да
  • N — нет

productsTableVariant
string

Вариант таблицы товаров

isDeleted
char

Признак удаления шаблона. Возможные значения:

  • Y — удален
  • N — не удален

isDefault
char

Признак шаблона по умолчанию. Возможные значения:

  • Y — да
  • N — нет

download
string

Ссылка на скачивание шаблона

downloadMachine
string

Ссылка на скачивание шаблона для машинной обработки

users
array

Массив кодов доступа, если поле выбрано в select

providers
array

Массив провайдеров, если поле выбрано в select

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "You do not have permissions to modify templates"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

0

You do not have permissions to modify templates

Недостаточно прав для получения списка шаблонов

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

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

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение