Get a Requisite Template v 3.0 crm.[type].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: crm

Who can execute the method: a user with permission to view contacts or companies

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The crm.<type>.requisite.preset.get method returns a requisite template by ID together with its fields. The fields show what can be filled in for a requisite with this template. The owner type in the method name affects only the isDefault flag.

Method Name for the Object Type

Object type

Method

Company

crm.company.requisite.preset.get

Contact

crm.contact.requisite.preset.get

Template methods only read data. Templates are created and configured in the Bitrix24 interface.

The method name is written in lowercase: crm.company.requisite.preset.get, not crm.company.requisite.Preset.Get. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Template ID.

The ID can be retrieved with the crm.<type>.requisite.preset.list method. The method does not return an inactive template

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.company.requisite.preset.get

The examples retrieve the German "Unternehmen" template with the ID 1. On your Bitrix24, the template ID may differ: retrieve it with the crm.<type>.requisite.preset.list method. For a contact, replace the method name with crm.contact.requisite.preset.get.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.requisite.preset.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.company.requisite.preset.get
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type PresetField = {
          name: string
          kind: 'requisiteField' | 'address' | 'userField'
          title: string
          inShortList: boolean
          sort: number
        }
        
        type PresetGetResult = {
          item: {
            id: number
            name: string
            isDefault: boolean
            sort: number
            fields: PresetField[]
          }
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<PresetGetResult>(
            'crm.company.requisite.preset.get',
            {
              id: 1,
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Preset:', result.item)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getPreset() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.company.requisite.preset.get',
                {
                  id: 1,
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Preset:', result.item)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getPreset)
        </script>
        

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.company.requisite.preset.get"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "id": 1,
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.requisite.preset.get',
                    [
                        'id' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

BX24.callMethod(
            'crm.company.requisite.preset.get',
            {
                id: 1,
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.requisite.preset.get',
            [
                'id' => 1,
            ]
        );
        
        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.company.requisite.preset.get", b24.Params{
        	"id": 1,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.company.requisite.preset.get: %w", err)
        }
        
        var result struct {
        	Item struct {
        		ID        int    `json:"id"`
        		Name      string `json:"name"`
        		IsDefault bool   `json:"isDefault"`
        		Fields    []struct {
        			Name string `json:"name"`
        			Kind string `json:"kind"`
        		} `json:"fields"`
        	} `json:"item"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, field := range result.Item.Fields {
        	fmt.Println(field.Kind, field.Name)
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 1,
                    "name": "Unternehmen",
                    "isDefault": true,
                    "sort": 500,
                    "fields": [
                        {
                            "name": "companyTitle",
                            "kind": "requisiteField",
                            "title": "",
                            "inShortList": true,
                            "sort": 510
                        },
                        {
                            "name": "vatNumber",
                            "kind": "requisiteField",
                            "title": "",
                            "inShortList": false,
                            "sort": 520
                        },
                        {
                            "name": "usrle",
                            "kind": "requisiteField",
                            "title": "",
                            "inShortList": false,
                            "sort": 530
                        },
                        {
                            "name": "inn",
                            "kind": "requisiteField",
                            "title": "",
                            "inShortList": true,
                            "sort": 540
                        },
                        {
                            "name": "",
                            "kind": "address",
                            "title": "",
                            "inShortList": false,
                            "sort": 550
                        }
                    ]
                }
            },
            "time": {
                "start": 1793711900,
                "finish": 1793711900.089311,
                "duration": 0.08931088447570801,
                "processing": 0,
                "date_start": "2026-11-03T16:18:20+03:00",
                "date_finish": "2026-11-03T16:18:20+03:00",
                "operating_reset_at": 1793712480,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.item.id
integer

Template ID. Passed in the presetId of a requisite

result.item.name
string

Template name

result.item.isDefault
boolean

true if the template is the default one for the owner type from the method name. The same template can be the default for companies and a regular one for contacts

result.item.sort
integer

Template sort order

result.item.fields
object[]

Template fields in the order they appear in the card. Each element contains:

  • name — field name. For kind: "requisiteField", the name of a requisite field that can be passed in fields of the add and update methods. For kind: "address", an empty string
  • kind — element kind: requisiteField is a requisite field, address means the template has addresses, userField is a custom field
  • title — field title in the template. An empty string if the standard title is used
  • inShortList — whether the field is shown in the short card form
  • sort — field order in the template

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
                "message": "Entity with ID 999 was not found."
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

id

Required field id is missing

Pass the template id

id

This request requires data type int in field id

Pass the ID as a number

Template Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

-

Entity with ID #ID# was not found

The template does not exist or is inactive. Retrieve the available templates with the crm.<type>.requisite.preset.list method

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field select found in entity PresetDto

Remove select and filter from the request: the template is returned in full

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP status: 403

Field

Error description

How to Fix

-

Access denied

You need permission to view contacts or companies, depending on the type in the method name

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Method #METHOD# was not found

Check the method name: it is written in lowercase, for example, crm.company.requisite.preset.get. Requisite methods exist only for contacts and companies: the company or contact segment

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

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

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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