Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd
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: any user
Returns the fields available for addition to the specified company details template.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
preset* |
An object containing the identifier of the template for which to retrieve the list of available customizable fields. Template identifiers can be obtained using the crm.requisite.preset.list method. Fields with the prefix |
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.availabletoadd
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.availabletoadd
// 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
try {
const response = await $b24.actions.v2.call.make<string[]>({
method: 'crm.requisite.preset.field.availabletoadd',
params: {
preset: {
ID: 27,
},
},
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('Available fields:', result, 'Count:', result.length)
}
} 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 getAvailablePresetFields() {
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.field.availabletoadd',
params: {
preset: {
ID: 27,
},
},
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('Available fields:', result, 'Count:', result.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getAvailablePresetFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.field.availabletoadd(
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}")
try {
$response = $b24Service
->core
->call(
'crm.requisite.preset.field.availabletoadd',
[
'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 checking available fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.preset.field.availabletoadd",
{
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.availabletoadd',
[
'preset' => ['ID' => 27]
]
);
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.field.availabletoadd", b24.Params{
"preset": b24.Params{
"ID": 27,
},
})
if err != nil {
return fmt.Errorf("crm.requisite.preset.field.availabletoadd: %w", err)
}
var items []string
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("received:", len(items))
Response Handling
HTTP status: 200
{
"result": [
"RQ_FIRST_NAME",
"RQ_LAST_NAME",
"RQ_SECOND_NAME",
"RQ_COMPANY_NAME",
"RQ_COMPANY_FULL_NAME",
"RQ_COMPANY_REG_DATE",
"RQ_DIRECTOR",
"RQ_ACCOUNTANT",
"RQ_ADDR",
"RQ_CONTACT",
"RQ_EMAIL",
"RQ_PHONE",
"RQ_FAX",
"RQ_IDENT_DOC",
"RQ_IDENT_DOC_SER",
"RQ_IDENT_DOC_NUM",
"RQ_IDENT_DOC_DATE",
"RQ_IDENT_DOC_ISSUED_BY",
"RQ_IDENT_DOC_DEP_CODE",
"RQ_INN",
"RQ_KPP",
"RQ_IFNS",
"RQ_OGRN",
"RQ_OGRNIP",
"RQ_OKPO",
"RQ_OKTMO",
"RQ_OKVED",
"RQ_ST_CERT_SER",
"RQ_ST_CERT_NUM",
"RQ_ST_CERT_DATE",
"RQ_SIGNATURE",
"RQ_STAMP",
"UF_CRM_1707997209",
"UF_CRM_1707997236",
"UF_CRM_1707997253",
"UF_CRM_1708012333"
]
}
Returned Data
|
Name |
Description |
|
result |
An array with the names of fields that can be added to the specified requisite template |
|
time |
Information about the request execution time |
Field Descriptions
|
Name |
Description |
|
RQ_FIRST_NAME |
First Name |
|
RQ_LAST_NAME |
Last Name |
|
RQ_SECOND_NAME |
Patronymic |
|
RQ_COMPANY_NAME |
Short name of the organization |
|
RQ_COMPANY_FULL_NAME |
Full name of the organization |
|
RQ_COMPANY_REG_DATE |
Date of state registration |
|
RQ_DIRECTOR |
General director |
|
RQ_ACCOUNTANT |
Chief accountant |
|
RQ_CONTACT |
Contact person |
|
RQ_EMAIL |
|
|
RQ_PHONE |
Phone |
|
RQ_FAX |
Fax |
|
RQ_IDENT_DOC |
Type of document |
|
RQ_IDENT_DOC_SER |
Series |
|
RQ_IDENT_DOC_NUM |
Number |
|
RQ_IDENT_DOC_DATE |
Date of issue |
|
RQ_IDENT_DOC_ISSUED_BY |
Issued by |
|
RQ_IDENT_DOC_DEP_CODE |
Department code |
|
RQ_INN |
TIN |
|
RQ_KPP |
KPP |
|
RQ_IFNS |
IFNS |
|
RQ_OGRN |
OGRN |
|
RQ_OGRNIP |
OGRNIP |
|
RQ_OKPO |
OKPO |
|
RQ_OKTMO |
OKTMO |
|
RQ_OKVED |
OKVED |
|
RQ_ST_CERT_SER |
Series of State Registration Certificate |
|
RQ_ST_CERT_NUM |
Number of State Registration Certificate |
|
RQ_ST_CERT_DATE |
Date of State Registration Certificate |
|
UF_CRM_1707997209 |
Custom Field of Type "Number" |
|
UF_CRM_1707997236 |
Custom Field of Type "Yes/No" |
|
UF_CRM_1707997253 |
Custom Field of Type "Date" |
|
UF_CRM_1708012333 |
Custom Field of Type "String" |
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "Template 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 not found |
The template for which to retrieve the list of available fields was not found |
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
- 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 Custom Field of Requisite Template by ID crm.requisite.preset.field.get
- Get a List of All Customizable Fields for a Specified CRM Requisites Template crm.requisite.preset.field.list
- 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