Get a list of requisites templates by filter crm.requisite.preset.list

Scope: crm

Who can execute the method: any user

The method returns a list of requisites templates based on the filter.

Method Parameters

Name `type`	Description
select `array`	An array of fields to select (see template fields). If the array is not provided or an empty array is passed, all available template fields will be selected.
filter `object`	An object for filtering selected templates in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field` correspond to template fields. An additional prefix can be set 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 in the filter value does not need to be passed. The search looks for the substring in any position of the string. `=%` — LIKE, substring search. The `%` symbol needs to be passed in the value. Examples: `"mol%"` — searches for values starting with "mol" `"%mol"` — searches for values ending with "mol" `"%mol%"` — searches for values where "mol" can be in any position `%=` — LIKE (similar to `=%`) `!%` — NOT LIKE, substring search. The `%` symbol in the filter value does not need to be passed. The search goes from both sides. `!=%` — NOT LIKE, substring search. The `%` symbol needs to be passed in the value. Examples: `"mol%"` — searches for values not starting with "mol" `"%mol"` — searches for values not ending with "mol" `"%mol%"` — searches for values where the substring "mol" is not present in any position `!%=` — NOT LIKE (similar to `!=%`) `=` — equal, exact match (used by default) `!=` — not equal `!` — not equal
order `object`	An object for sorting selected templates in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` correspond to template fields. Possible values for `order`: `asc` — in ascending order `desc` — in descending order
start `integer`	This parameter is used to manage pagination. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value `50`. 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

Description of requisites template fields

Name `type`	Description
ID `integer`	Identifier of the requisite. Automatically created and unique within the account.
ENTITY_TYPE_ID `integer`	Identifier of the parent object's type. The identifiers of CRM object types are provided by the method crm.enum.ownertype.
COUNTRY_ID `integer`	Identifier of the country corresponding to the set of requisites template fields (to get available values, see the method crm.requisite.preset.countries).
DATE_CREATE `datetime`	Creation date.
DATE_MODIFY `datetime`	Modification date. Contains an empty string if the template has not been modified since creation.
CREATED_BY_ID `user`	Identifier of the user who created the requisite.
MODIFY_BY_ID `user`	Identifier of the user who modified the requisite.
NAME `string`	Name of the requisite.
XML_ID `string`	External key. Used for exchange operations. Identifier of the object in the external information base. The purpose of the field may change by the final developer. Each application ensures the uniqueness of values in this field. It is recommended to use a unique prefix to avoid collisions with other applications. Values of the form `#CRM_REQUISITE_PRESET_DEF_...` are reserved in CRM for identifying templates that are used by default. These identifiers should not be used for your purposes, as this may lead to logic violations.
ACTIVE `char`	Activity status. Uses values `Y` or `N`. Determines the availability of the template in the selection list when adding requisites.
SORT `integer`	Sorting.

Code Examples

How to Use Examples in Documentation

Searching for templates by country binding:

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'crm.requisite.preset.list',
            {
              order: { "ID": "ASC" },
              filter: { "COUNTRY_ID": "1"},
              select: [ "ID", "NAME"]
            },
            (progress) => { 
              if(progress.error())
                console.error(progress.error());
              else
              {
                console.dir(progress.data());
                if(progress.more())
                  progress.next();
              }
            }
          )
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('crm.requisite.preset.list', { order: { "ID": "ASC" }, filter: { "COUNTRY_ID": "1"}, select: [ "ID", "NAME"] }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { 
              console.dir(entity);
            }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.requisite.preset.list', { order: { "ID": "ASC" }, filter: { "COUNTRY_ID": "1"}, select: [ "ID", "NAME"] }, 0)
          const result = response.getData().result || []
          for (const entity of result) { 
            console.dir(entity);
          }
        } catch (error) {
          console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.preset.list',
                    [
                        'order'  => ['ID' => 'ASC'],
                        'filter' => ['COUNTRY_ID' => '1'],
                        'select' => ['ID', 'NAME'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching requisite presets: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.preset.list",
            {
                order: { "ID": "ASC" },
                filter: { "COUNTRY_ID": "1"},
                select: [ "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.preset.list',
            [
                'order' => ['ID' => 'ASC'],
                'filter' => ['COUNTRY_ID' => '1'],
                'select' => ['ID', 'NAME']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "ID": "1",
                    "NAME": "Organization"
                },
                {
                    "ID": "2",
                    "NAME": "Sole Proprietor"
                },
                {
                    "ID": "3",
                    "NAME": "Individual"
                },
                {
                    "ID": "4",
                    "NAME": "Organization (additional)"
                }
            ],
            "total": 4,
            "time": {
                "start": 1716564019.674636,
                "finish": 1716564020.067474,
                "duration": 0.3928380012512207,
                "processing": 0.02863287925720215,
                "date_start": "2024-05-24T17:20:19+02:00",
                "date_finish": "2024-05-24T17:20:20+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	An array of objects with information about the selected templates. Each element contains the selected template fields.
total `integer`	Total number of records found.
time `time`	Information about the execution time of the request.

Error Handling

HTTP status: 40x, 50x

{
            "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 Error Codes

Code	Description
`Access denied`	Insufficient access permissions to retrieve the list of templates.

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 Requisite Template Fields by ID

Delete Requisite Template

Get a list of requisites templates by filter crm.requisite.preset.list

Method ParametersMethod Parameters

Description of requisites template fieldsDescription of requisites template fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning