Get the list of agreements userconsent.agreement.list

Scope: userconsent

Who can execute the method: any user

The method userconsent.agreement.list returns a list of agreements.

Method Parameters

No parameters.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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: Retrieves all data at once.
        // Use only for small selections (< 1000 items) due to high
        // memory load.
        
        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: Retrieves data in parts using an iterator.
        // Use for large volumes of data for efficient memory consumption.
        
        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: Manual control of pagination through the start parameter.
        // Use for precise control over request batches.
        // Less efficient for large data than 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>';

Response Handling

HTTP status: 200

{
        "result": [
            {
             "ID": "35",
             "NAME": "Consent to receive newsletters",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "de"
            },
            {
             "ID": "33",
             "NAME": "Conditions of use for Bitrix24 Sites",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "fr"
            },
            {
             "ID": "31",
             "NAME": "Terms of use for the notification service",
             "ACTIVE": "Y",
             "LANGUAGE_ID": null
            },
            {
             "ID": "29",
             "NAME": "ALEX",
             "ACTIVE": "Y",
             "LANGUAGE_ID": ""
            },
            {
             "ID": "27",
             "NAME": "Terms of use for the B24 Notification Center",
             "ACTIVE": "Y",
             "LANGUAGE_ID": null
            },
            {
             "ID": "25",
             "NAME": "Termos de Uso do Bitrix24 Sites",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "br"
            },
            {
             "ID": "23",
             "NAME": "Second agreement",
             "ACTIVE": "Y",
             "LANGUAGE_ID": ""
            },
            {
             "ID": "21",
             "NAME": "Bitrix24 Sites: Terms of Use",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "de"
            },
            {
             "ID": "19",
             "NAME": "Consent with Cookies",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "de"
            },
            {
             "ID": "17",
             "NAME": "Cookie consent",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "en"
            },
            {
             "ID": "15",
             "NAME": "Rules for using Bitrix24.Sites",
             "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": "Rules for using Bitrix24.Sites",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "es"
            },
            {
             "ID": "7",
             "NAME": "Rules for using Bitrix24.Sites",
             "ACTIVE": "Y",
             "LANGUAGE_ID": "de"
            },
            {
             "ID": "1",
             "NAME": "Example of consent for processing personal data",
             "ACTIVE": "Y",
             "LANGUAGE_ID": ""
            }
        ],
        "time": {
            "start": 1760352862,
            "finish": 1760352862.776508,
            "duration": 0.776508092880249,
            "processing": 0,
            "date_start": "2025-10-13T13:54:22+02:00",
            "date_finish": "2025-10-13T13:54:22+02:00",
            "operating_reset_at": 1760353462,
            "operating": 0
        }
        }

Returned Data

Name `type`	Description
result `array`	Root element of the response
ID `integer`	Identifier of the agreement
NAME `string`	Name of the agreement
ACTIVE `string`	Activity status. Possible values: `Y` — yes `N` — no
LANGUAGE_ID `string`	Language identifier of the agreement
time `time`	Information about the request execution time

Error Handling

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Get Agreement Text

Get the list of agreements userconsent.agreement.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning