Get Requisite Template Fields by ID crm.requisite.preset.get

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: crm

Who can execute the method: any user

This method returns the requisite template by its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the requisite template. It can be obtained using the method crm.requisite.preset.list

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>
        
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>';
        
from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        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}")
        

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
type

Description

result
object

An object containing the values of the template fields

time
time

Information about the request execution time

Description of the Requisite Template Fields

Name
type

Description

ID
integer

Identifier of the requisite. Created automatically and unique within the account

ENTITY_TYPE_ID
integer

Identifier of the parent object type.

The identifiers of CRM object types are provided by the method crm.enum.ownertype

COUNTRY_ID
integer

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
datetime

Create date

DATE_MODIFY
datetime

Modification date. Contains an empty string if the template has not been changed since creation

CREATED_BY_ID
user

Identifier of the user who created the requisite

MODIFY_BY_ID
user

Identifier of the user who modified the requisite

NAME
string

Name of the requisite

XML_ID
string

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 #CRM_REQUISITE_PRESET_DEF_... are reserved in CRM for identifying templates that are used by default. These identifiers should not be used for your purposes, as this may lead to logic violations

ACTIVE
char

Activity status. Uses values Y or N. Determines the availability of the template in the selection list when adding requisites

SORT
integer

Sorting

Error Handling

HTTP status: 40x, 50x

{
            "error": "",
            "error_description": "The Preset with ID '347' is not found"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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

The Preset with ID '347' is not found

Template with the specified identifier not found

Access denied

Insufficient access permissions to retrieve the template

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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