Получить список соглашений userconsent.agreement.list

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: userconsent

Кто может выполнять метод: любой пользователь

Метод userconsent.agreement.list возвращает список соглашений.

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

Без параметров.

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userconsent.agreement.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userconsent.agreement.list
        
// callListMethod: Получает все данные сразу.
        // Используйте только для небольших выборок (< 1000 элементов) из-за высокой
        // нагрузки на память.
        
        try {
        const response = await $b24.callListMethod(
            'userconsent.agreement.list',
            {},
            (progress: number) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора.
        // Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
        const generator = $b24.fetchListMethod('userconsent.agreement.list', {}, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start.
        // Используйте для точного контроля над пакетами запросов.
        // Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
        const response = await $b24.callMethod('userconsent.agreement.list', {}, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'userconsent.agreement.list',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching agreement list: ' . $e->getMessage();
        }
        
BX24.callMethod(
        'userconsent.agreement.list',
        {},
        function(result) {
            if (result.error()) {
            console.error(result.error());
            } else {
            console.log(result.data());
            }
        }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'userconsent.agreement.list',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
        "result": [
            {
             "ID": "35",
             "NAME": "Согласие на получение рассылки",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "ru"
            },
            {
             "ID": "33",
             "NAME": "Conditions d'utilisation de Bitrix24 Sites",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "fr"
            },
            {
             "ID": "31",
             "NAME": "Условия использования сервиса уведомлений",
             "ACTIVE": "Y",
             "LANGUAGE_ID": null
            },
            {
             "ID": "29",
             "NAME": "SASHA",
             "ACTIVE": "Y",
             "LANGUAGE_ID": ""
            },
            {
             "ID": "27",
             "NAME": "Условия использования Центра уведомлений Б24",
             "ACTIVE": "Y",
             "LANGUAGE_ID": null
            },
            {
             "ID": "25",
             "NAME": "Termos de Uso do Bitrix24 Sites",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "br"
            },
            {
             "ID": "23",
             "NAME": "Второе соглашение",
             "ACTIVE": "Y",
             "LANGUAGE_ID": ""
            },
            {
             "ID": "21",
             "NAME": "Bitrix24 Sites: Nutzungsbedingungen",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "de"
            },
            {
             "ID": "19",
             "NAME": "Согласие с Cookies-файлами",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "ru"
            },
            {
             "ID": "17",
             "NAME": "Cookie consent",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "en"
            },
            {
             "ID": "15",
             "NAME": "Правила використання Бітрікс24.Сайти",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "ua"
            },
            {
             "ID": "13",
             "NAME": "Test newwef",
             "ACTIVE": "Y",
             "LANGUAGE_ID": ""
            },
            {
             "ID": "11",
             "NAME": "Bitrix24 Sites Terms of Use",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "en"
            },
            {
             "ID": "9",
             "NAME": "Правила использования Битрикс24.Сайты",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "es"
            },
            {
             "ID": "7",
             "NAME": "Правила использования Битрикс24.Сайты",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "ru"
            },
            {
             "ID": "1",
             "NAME": "Пример согласия на обработку персональных данных",
             "ACTIVE": "Y",
             "LANGUAGE_ID": ""
            }
        ],
        "time": {
            "start": 1760352862,
            "finish": 1760352862.776508,
            "duration": 0.776508092880249,
            "processing": 0,
            "date_start": "2025-10-13T13:54:22+03:00",
            "date_finish": "2025-10-13T13:54:22+03:00",
            "operating_reset_at": 1760353462,
            "operating": 0
        }
        }

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

Название
тип

Описание

result
array

Корневой элемент ответа

ID
integer

Идентификатор соглашения

NAME
string

Название соглашения

ACTIVE
string

Признак активности. Возможные значения:

  • Y — да
  • N — нет

LANGUAGE_ID
string

Идентификатор языка соглашения

time
time

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

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

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

HTTP-статус: 20x, 40x, 50x

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

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Обзор методов
Следующая
Получить текст соглашения