Get a List of All Customizable Fields for a Specified CRM Requisites Template crm.requisite.preset.field.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
crmWho can execute the method: any user
Returns a list of all customizable fields for a specific company details template.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
preset* |
An object containing the identifier value of the template from which the list of customizable fields is extracted (for example, |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.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 item returned in result[]
type PresetFieldItem = {
ID: number
FIELD_NAME: string
FIELD_TITLE: string
IN_SHORT_LIST: string
SORT: number
}
try {
// crm.requisite.preset.field.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<PresetFieldItem[]>({
method: 'crm.requisite.preset.field.list',
params: {
preset: {
ID: 27,
},
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 fields:', 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 listPresetFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.requisite.preset.field.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.field.list',
params: {
preset: {
ID: 27,
},
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 fields:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listPresetFields)
</script>
try {
$response = $b24Service
->core
->call(
'crm.requisite.preset.field.list',
[
'preset' => [
'ID' => 27
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching preset field list: ' . $e->getMessage();
}
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.preset.field.list(
preset={
"ID": 27,
},
).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.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.preset.field.list(
preset={
"ID": 27,
},
).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.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.preset.field.list(
preset={
"ID": 27,
},
).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}")
BX24.callMethod(
"crm.requisite.preset.field.list",
{
preset:
{
"ID": 27
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.preset.field.list',
[
'preset' => ['ID' => 27]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": [
{
"ID": 1,
"FIELD_NAME": "RQ_INN",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "Y",
"SORT": 510
},
{
"ID": 2,
"FIELD_NAME": "RQ_COMPANY_NAME",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "Y",
"SORT": 520
},
{
"ID": 3,
"FIELD_NAME": "RQ_COMPANY_FULL_NAME",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 530
},
{
"ID": 4,
"FIELD_NAME": "RQ_OGRN",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 540
},
{
"ID": 5,
"FIELD_NAME": "RQ_KPP",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "Y",
"SORT": 550
},
{
"ID": 6,
"FIELD_NAME": "RQ_COMPANY_REG_DATE",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 560
},
{
"ID": 7,
"FIELD_NAME": "RQ_OKPO",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 570
},
{
"ID": 8,
"FIELD_NAME": "RQ_OKTMO",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 580
},
{
"ID": 9,
"FIELD_NAME": "RQ_DIRECTOR",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 590
},
{
"ID": 10,
"FIELD_NAME": "RQ_ACCOUNTANT",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 600
},
{
"ID": 11,
"FIELD_NAME": "RQ_ADDR",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 610
},
{
"ID": 12,
"FIELD_NAME": "RQ_SIGNATURE",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 620
},
{
"ID": 13,
"FIELD_NAME": "RQ_STAMP",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "N",
"SORT": 630
},
{
"ID": 14,
"FIELD_NAME": "UF_CRM_1703689889",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "Y",
"SORT": 640
},
{
"ID": 15,
"FIELD_NAME": "UF_CRM_1703690003",
"FIELD_TITLE": "",
"IN_SHORT_LIST": "Y",
"SORT": 650
}
],
"time": {
"start": 1716895759.934609,
"finish": 1716895760.407579,
"duration": 0.47297000885009766,
"processing": 0.023286104202270508,
"date_start": "2024-05-28T13:29:19+02:00",
"date_finish": "2024-05-28T13:29:20+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An array of objects describing the customizable fields of the requisites template. Each element contains fields of the customizable field template |
|
total |
The total number of records found |
|
time |
Information about the request execution time |
Fields Describing The
Customizable Field of the Requisites Template
#|
|| Name
type | Description ||
|| ID
integer | Field identifier. Created automatically and unique within the template ||
|| FIELD_NAME
string | Field name ||
|| FIELD_TITLE
string | An alternative name for the field in the requisite.
The alternative name is displayed in various forms for filling out requisites. Depending on the specific form, the alternative name may or may not be used
||
|| SORT
integer | Sorting. The order in the list of template fields ||
|| IN_SHORT_LIST
char | Show in the short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values Y or N ||
|#
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "The Preset with ID '27' is not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Template with the specified identifier not found |
|
|
Insufficient access permissions to retrieve the list of customizable fields of the template |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.add
- Update Custom Field of a Given Requisite Template crm.requisite.preset.field.update
- Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd
- Get Custom Field of Requisite Template by ID crm.requisite.preset.field.get
- Delete Custom Field from CRM Requisite Template crm.requisite.preset.field.delete
- Get Description of Custom Fields for the Requisite Template crm.requisite.preset.field.fields