Get a List of Requisites Templates by Filter crm.requisite.preset.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with "read" access permission for contacts and companies
Retrieves a list of company details templates based on the filter.
Method Parameters
|
Name |
Description |
|
select |
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 |
An object for filtering selected templates in the format Possible values for An additional prefix can be set for the key to clarify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting selected templates in the format Possible values for Possible values for
|
|
start |
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 The formula for calculating the
|
Description of Requisites Template Fields
|
Name |
Description |
|
ID |
Identifier of the template. Created automatically and unique within Bitrix24 |
|
ENTITY_TYPE_ID |
Identifier of the parent object type. The identifiers of CRM object types are provided by the method crm.enum.ownertype |
|
COUNTRY_ID |
Identifier of the country corresponding to the set of fields in the requisites template (for available values, see the method crm.requisite.preset.countries) |
|
DATE_CREATE |
Create date |
|
DATE_MODIFY |
Modification date. Contains an empty string if the template has not been changed since creation |
|
CREATED_BY_ID |
Identifier of the user who created the template |
|
MODIFY_BY_ID |
Identifier of the user who modified the template |
|
NAME |
Name of the template |
|
XML_ID |
External key. Used for exchange operations. Identifier of the external information base object. 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 |
|
ACTIVE |
Activity status. Values |
|
SORT |
Sorting |
Code Examples
How to Use Examples in Documentation
Searching for templates by country binding:
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
// 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
// Shape of each PresetItem returned in result[]
type PresetItem = {
ID: string
NAME: string
}
try {
// crm.requisite.preset.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<PresetItem[]>({
method: 'crm.requisite.preset.list',
params: {
order: { ID: 'ASC' },
filter: { COUNTRY_ID: '1' },
select: ['ID', 'NAME'],
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('Preset count on this page:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 fetchRequisitePresets() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.requisite.preset.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: 'crm.requisite.preset.list',
params: {
order: { ID: 'ASC' },
filter: { COUNTRY_ID: '1' },
select: ['ID', 'NAME'],
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('Preset count on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchRequisitePresets)
</script>
Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.list(
order={"ID": "ASC"},
filter={"COUNTRY_ID": "1"},
select=["ID", "NAME"],
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
Example as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.list(
order={"ID": "ASC"},
filter={"COUNTRY_ID": "1"},
select=["ID", "NAME"],
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Bitrix API Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
Example as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.list(
filter={"COUNTRY_ID": "1"},
select=["ID", "NAME"],
order={"ID": "DESC"},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Bitrix API Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.requisite.preset.list", b24.Params{
"order": b24.Params{
"ID": "ASC",
},
"filter": b24.Params{
"COUNTRY_ID": "1",
},
"select": []string{"ID", "NAME"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.requisite.preset.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP status: 200
{
"result": [
{
"ID": "1",
"NAME": "Organization"
},
{
"ID": "2",
"NAME": "Sole Proprietorship"
},
{
"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 |
Description |
|
result |
An array of objects with information about the selected templates. Each element contains the selected template fields. |
|
total |
The total number of records found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 40x, 50x
{
"error":0,
"error_description":"Access denied."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient access permissions to retrieve the list of templates. |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a Template crm.requisite.preset.add
- Update Requisite Template crm.requisite.preset.update
- Get a List of Countries for the Template crm.requisite.preset.countries
- Get Requisite Template Fields by ID crm.requisite.preset.get
- Delete Company Details Template crm.requisite.preset.delete
- Get Description of the Fields of the Requisite Template crm.requisite.preset.fields
- Add a Company with Requisites via Web Form
- Add a Contact with Requisites via Web Form