# documentgenerator.role.list

URL: https://chugunov.pro/api-bitrix24/document-generator/role/document-generator-role-list/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список ролей
Scope: `documentgenerator`
Кто может выполнять метод: пользователь с правом на изменение настроек генератора документов

## Описание

Метод `documentgenerator.role.list` возвращает список ролей без детализации прав.

## Параметры

- `start` `integer` — необязательный. Параметр используется для управления постраничной навигацией.
  Размер страницы результатов всегда статичный — 50 записей.
  Чтобы выбрать вторую страницу результатов, необходимо передавать значение `50`. Чтобы выбрать третью страницу результатов — значение `100` и так далее.
  Формула расчета значения параметра `start`:
  `start = (N — 1) * 50`, где `N` — номер нужной страницы

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "roles": [
            {
                "id": 1,
                "name": "Администратор",
                "code": "ADMIN"
            },
            {
                "id": 3,
                "name": "Менеджер",
                "code": "MANAGER"
            },
            {
                "id": 9,
                "name": "Редакторы своих шаблонов",
                "code": "DOCGEN_TEMPLATE_EDITORS"
            }
        ]
    },
    "total": 3,
    "time": {
        "start": 1774015085,
        "finish": 1774015085.612552,
        "duration": 0.6125519275665283,
        "processing": 0,
        "date_start": "2026-03-20T16:58:05+03:00",
        "date_finish": "2026-03-20T16:58:05+03:00",
        "operating_reset_at": 1774015685,
        "operating": 0
    }
}
```

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

- `result` `object`. Корневой элемент ответа [(подробное описание)](#result)
- `total` `integer`. Количество ролей в текущей выборке
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "0",
    "error_description": "You do not have permissions to modify settings"
}
```

- `400` — `0`. You do not have permissions to modify settings
- `403` — `DOCGEN_ACCESS_ERROR`. Your plan does not support this operation

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"start":0}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.role.list
```

### cURL (OAuth)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"start":0,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/documentgenerator.role.list
```

### JS (TS)

```ts
// 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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type RoleItem = {
  id: number
  name: string
  code: string
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type RoleListResult = {
  roles: RoleItem[]
}

try {
  // documentgenerator.role.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<RoleListResult>({
    method: 'documentgenerator.role.list',
    params: {
      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(result.roles.length, result.roles)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 listRoles() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // documentgenerator.role.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.role.list',
        params: {
          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(result.roles.length, result.roles)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listRoles)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.documentgenerator.role.list(
        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}")
```

### PHP

```php
try {
    $response = $b24Service->core->call(
        'documentgenerator.role.list',
        [
            'start' => 0,
        ]
    );

    $result = $response->getResponseData()->getResult();
    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'documentgenerator.role.list',
    {},
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());

            if (result.more())
            {
                result.next();
            }
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'documentgenerator.role.list',
    [
        'start' => 0,
    ]
);

print_r($result);
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.role.list", b24.Params{
	"start": 0,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("documentgenerator.role.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "roles".
raw, ok := b24.Unwrap(res.Result, "roles")
if !ok {
	return fmt.Errorf("в ответе нет ключа roles")
}

var items []struct {
	ID   b24.ID `json:"id"`
	Name string `json:"name"`
	Code string `json:"code"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID)
}
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/document-generator/role/document-generator-role-list.html