Get Description of the Fields of the Requisite Template crm.requisite.preset.fields
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
The method returns a formal description of the fields of the requisite template.
No parameters.
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 '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.fields
// 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
type FieldAttributeItem = {
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
isDynamic: boolean
title: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type PresetFieldsResult = Record<string, FieldAttributeItem>
try {
const response = await $b24.actions.v2.call.make<PresetFieldsResult>({
method: 'crm.requisite.preset.fields',
params: {},
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 field names:', Object.keys(result))
console.info('First field details:', result[Object.keys(result)[0]])
}
} 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 getPresetFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.preset.fields',
params: {},
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 field names:', Object.keys(result))
console.info('First field details:', result[Object.keys(result)[0]])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getPresetFields)
</script>
try {
$response = $b24Service
->core
->call(
'crm.requisite.preset.fields',
[]
);
$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 requisite preset fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.preset.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.preset.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.preset.fields().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}")
Response Handling
HTTP status: 200
{
"result": {
"ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID"
},
"ENTITY_TYPE_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Object type ID"
},
"COUNTRY_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Country ID"
},
"NAME": {
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Name"
},
"DATE_CREATE": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Creation date"
},
"DATE_MODIFY": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modification date"
},
"CREATED_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Created by"
},
"MODIFY_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modified by"
},
"ACTIVE": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Active"
},
"SORT": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Sorting"
},
"XML_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "External code"
}
},
"time": {
"start": 1716555914.663808,
"finish": 1716555914.996533,
"duration": 0.33272480964660645,
"processing": 0.008843183517456055,
"date_start": "2024-05-24T15:05:14+02:00",
"date_finish": "2024-05-24T15:05:14+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An object in the format |
|
time |
Information about the request execution time |
Description of the Requisite Template Fields
|
Name |
Description |
|
ID |
Identifier of the requisite. Created automatically and unique within the account |
|
ENTITY_TYPE_ID |
Identifier of the parent object's type. Currently, this is only "Requisite" (identifier 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 requisite |
|
MODIFY_BY_ID |
Identifier of the user who modified the requisite |
|
NAME |
Name of the requisite |
|
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 |
Description of Attributes
|
Name |
Description |
|
type |
Field type |
|
isRequired |
"Required" attribute. Possible values:
|
|
isReadOnly |
"Read-only" attribute. Possible values:
|
|
isImmutable |
"Immutable" attribute. Possible values:
|
|
isMultiple |
"Multiple" attribute. Possible values:
|
|
isDynamic |
"Custom" attribute. Possible values:
|
|
title |
Field identifier |
Error Handling
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
- 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
- Get a List of Requisites Templates by Filter crm.requisite.preset.list
- Delete Company Details Template crm.requisite.preset.delete