Get a List of Requisites by Filter crm.requisite.list

Scope: crm

Who can execute the method: any user

This method retrieves a list of requisites based on a filter.

Method Parameters

Name `type`	Description
select `array`	An array containing the list of fields to be selected (see requisite fields). If not provided or an empty array is passed, all available requisite fields will be selected.
filter `object`	An object for filtering the selected requisites in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field` correspond to requisite fields. An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `@` — IN (an array is passed as the value) `!@`— NOT IN (an array is passed as the value) `%` — LIKE, substring search. The `%` symbol does not need to be included in the filter value. The search looks for the substring in any position of the string. `=%` — LIKE, substring search. The `%` symbol must be included in the value. Examples: "mol%" — searching for values starting with "mol" "%mol" — searching for values ending with "mol" "%mol%" — searching for values where "mol" can be in any position. `%=` — LIKE (see description above) `!%` — NOT LIKE, substring search. The `%` symbol does not need to be included in the filter value. The search is performed from both sides. `!=%` — NOT LIKE, substring search. The `%` symbol must be included in the value. Examples: "mol%" — searching for values not starting with "mol" "%mol" — searching for values not ending with "mol" "%mol%" — searching for values where the substring "mol" is not present in any position. `!%=` — NOT LIKE (see description above) `=` — equal, exact match (used by default) `!=` — not equal `!` — not equal
order `object`	An object for sorting the selected requisites in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` correspond to requisite fields. Possible values for `order`: `asc` — ascending order `desc` — descending order
start `integer`	This parameter is used for pagination control. The page size of results is always static: 50 records. To select the second page of results, the value `50` must be passed. To select the third page of results, the value is `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` is the desired page number

Code Example

How to Use Examples in Documentation

Retrieving requisites by template ID

cURL (Webhook)

cURL (OAuth)

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"DATE_CREATE":"ASC"},"filter":{"PRESET_ID":"1"},"select":["ENTITY_TYPE_ID","ENTITY_ID","ID","NAME"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"DATE_CREATE":"ASC"},"filter":{"PRESET_ID":"1"},"select":["ENTITY_TYPE_ID","ENTITY_ID","ID","NAME"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.list

BX24.callMethod(
            "crm.requisite.list",
            {
                order: { "DATE_CREATE": "ASC" },
                filter: { "PRESET_ID": "1"},
                select: [ "ENTITY_TYPE_ID", "ENTITY_ID", "ID", "NAME" ]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());
                    if(result.more())
                        result.next();
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.list',
            [
                'order' => ["DATE_CREATE" => "ASC"],
                'filter' => ["PRESET_ID" => "1"],
                'select' => ["ENTITY_TYPE_ID", "ENTITY_ID", "ID", "NAME"]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Retrieving the value of a custom field in requisites

cURL (Webhook)

cURL (OAuth)

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{},"filter":{"ID":"51"},"select":["UF_CRM_1707997209"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{},"filter":{"ID":"51"},"select":["UF_CRM_1707997209"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.list

BX24.callMethod(
            "crm.requisite.list",
            {
                order: {},
                filter: { "ID": "51"}, // Requisite ID
                select: [ "UF_CRM_1707997209"] // Custom field ID
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());    
                    if(result.more())
                        result.next();        
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.list',
            [
                'order' => [],
                'filter' => ['ID' => '51'],
                'select' => ['UF_CRM_1707997209']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP status: 200

Response from example 1:

{
        "result": [
            {
            "ENTITY_TYPE_ID": "4",
            "ENTITY_ID": "3027",
            "ID": "40",
            "NAME": "Organization"
            },
            {
            "ENTITY_TYPE_ID": "4",
            "ENTITY_ID": "3028",
            "ID": "41",
            "NAME": "Head Office Requisites"
            },
            {
            "ENTITY_TYPE_ID": "4",
            "ENTITY_ID": "3028",
            "ID": "42",
            "NAME": "Branch in Chernyakhovsk"
            }
        ],
        "total": 3,
        "time": {
            "start": 1717150154.197056,
            "finish": 1717150154.505106,
            "duration": 0.30804991722106934,
            "processing": 0.030454158782958984,
            "date_start": "2024-05-31T12:09:14+02:00",
            "date_finish": "2024-05-31T12:09:14+02:00",
            "operating": 0
        }
        }

Response from example 2:

{
            "result": [
                {
                    "UF_CRM_1707997209": "45"
                }
            ],
            "total": 1,
            "time": {
                "start": 1717151052.551011,
                "finish": 1717151052.94743,
                "duration": 0.39641880989074707,
                "processing": 0.028468847274780273,
                "date_start": "2024-05-31T12:24:12+02:00",
                "date_finish": "2024-05-31T12:24:12+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	An array of objects containing information from the selected requisites. Each element contains the selected requisite fields
total `integer`	The total number of records found
time `time`	Information about the execution time of the request

Error Response

HTTP status: 400

{
            "error": 0,
            "error_description": "Access denied."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Errors

Code	Error Text	Description
`0`	Access denied.	Insufficient access permissions to retrieve the list of requisites.

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

Get detail by id

Delete detail and related objects

Get a List of Requisites by Filter crm.requisite.list

Method ParametersMethod Parameters

Code ExampleCode Example

Successful ResponseSuccessful Response

Returned DataReturned Data

Error ResponseError Response

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning