Get Requisite Template Fields by ID crm.requisite.preset.get
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
This method returns the requisite template by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the requisite template. It can be obtained using the method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":347}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":347,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.get
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type RequisitePresetResult = {
ID: string
ENTITY_TYPE_ID: string
COUNTRY_ID: string
DATE_CREATE: ISODate | null
DATE_MODIFY: ISODate | null
CREATED_BY_ID: string
MODIFY_BY_ID: string | null
NAME: string
XML_ID: string
ACTIVE: string
SORT: string
}
try {
const response = await $b24.actions.v2.call.make<RequisitePresetResult>({
method: 'crm.requisite.preset.get',
params: {
id: 347,
},
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(result.ID, result.NAME, result.ACTIVE)
}
} 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 getRequisitePreset() {
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.get',
params: {
id: 347,
},
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(result.ID, result.NAME, result.ACTIVE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRequisitePreset)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.get(bitrix_id=347).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}")
try {
$response = $b24Service
->core
->call(
'crm.requisite.preset.get',
[
'id' => 347,
]
);
$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 getting requisite preset: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.preset.get",
{ id: 347 }, // Attribute template identifier.
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.preset.get',
[
'id' => 347
]
);
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.get", b24.Params{
"id": 347,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.requisite.preset.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
EntityTypeID b24.ID `json:"ENTITY_TYPE_ID"`
CountryID b24.ID `json:"COUNTRY_ID"`
DateCreate string `json:"DATE_CREATE"`
DateModify string `json:"DATE_MODIFY"`
CreatedByID b24.ID `json:"CREATED_BY_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.EntityTypeID)
Response Handling
HTTP status: 200
{
"result": {
"ID": "347",
"ENTITY_TYPE_ID": "8",
"COUNTRY_ID": "1",
"DATE_CREATE": "2024-05-24T15:45:44+02:00",
"DATE_MODIFY": "",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": null,
"NAME": "Smith LLC",
"XML_ID": "EXAMPLE_COMPANY__VALUE_1",
"ACTIVE": "Y",
"SORT": "520"
},
"time": {
"start": 1716558423.336056,
"finish": 1716558424.695338,
"duration": 1.3592820167541504,
"processing": 0.06150317192077637,
"date_start": "2024-05-24T15:47:03+02:00",
"date_finish": "2024-05-24T15:47:04+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An object containing the values of the template fields |
|
time |
Information about the request execution time |
Description of the Requisite 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. Uses values |
|
SORT |
Sorting |
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "The Preset with ID '347' is not found"
}
|
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 |
|
|
Template with the specified identifier not found |
|
|
Insufficient access permissions to retrieve the template |
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 a List of Requisites Templates by Filter crm.requisite.preset.list
- Delete Company Details Template crm.requisite.preset.delete
- Get Description of the Fields of the Requisite Template crm.requisite.preset.fields