Get a Field Requirement v 3.0 crm.[type].field.required.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 the "Edit CRM preferences" permission in CRM

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>.field.required.get method returns the field requirement configuration: the mode and the stages at which the field is required. The object type is set by the <type> segment of the method name.

Method Name for the Object Type

Object type	Method	Fields
Deal	`crm.deal.field.required.get`	Deal fields
Lead	`crm.lead.field.required.get`	Lead fields
Contact	`crm.contact.field.required.get`	Contact fields
Company	`crm.company.field.required.get`	Company fields
Estimate	`crm.quote.field.required.get`	Estimate fields
Invoice	`crm.smartinvoice.field.required.get`	Invoice fields
SPA	`crm.smartprocess<entityTypeId>.field.required.get`, for example, `crm.smartprocess1038.field.required.get`	SPA fields

For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field. SPAs have field requirement methods regardless of the type settings. My company does not have these methods: for crm.mycompany.field.required.get, Bitrix24 returns the "Method Not Found" error.

The method name is written in lowercase: crm.smartinvoice.field.required.get, not crm.smartInvoice.field.required.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
fieldId* `string`	Field name: a standard field in camelCase, for example, `title` or `opportunity`, or a custom field, for example, `UF_CRM_CONTRACT_NUMBER`. Field names are returned by the crm.<type>.field.list method
categoryId `integer`	Pipeline ID. When to pass it

The categoryId Parameter

Bitrix24 stores the field requirement separately for each pipeline. Whether to pass categoryId depends on the object type:

Object type	categoryId
Deal, contact, company	Required. The default pipeline is set by `0`, other pipelines by their IDs from the crm.<type>.category.list method
SPA	Required. The pipeline ID is returned by: the crm.<type>.category.list method if pipelines are enabled in the type the crm.category.list method with the `entityTypeId` of the SPA if pipelines are disabled. Such a type has no pipeline methods and only one pipeline
Invoice	Required. The invoice pipeline ID is returned by the crm.category.list method with `entityTypeId` = `31`: REST 3.0 has no pipeline method for invoices
Lead, estimate	Not passed

If categoryId does not follow the rules in the table, the method returns an error.

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.smartprocess1038.field.required.get

The examples retrieve the requirement of the "Contract number" field in pipeline 69 of an SPA with the type ID 1038. For a different object type, replace the method name according to the table above.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fieldId":"UF_CRM_CONTRACT_NUMBER","categoryId":69}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.required.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fieldId":"UF_CRM_CONTRACT_NUMBER","categoryId":69,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.required.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 RequirementResult = {
          item: {
            fieldId: string
            categoryId: number | null
            mode: 'none' | 'all' | 'stages'
            requiredStageIds: string[]
            globallyRequired: boolean
          }
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<RequirementResult>(
            'crm.smartprocess1038.field.required.get',
            {
              fieldId: 'UF_CRM_CONTRACT_NUMBER',
              categoryId: 69,
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.item.mode, result.item.requiredStageIds)
          }
        } 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 getRequirement() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.field.required.get',
                {
                  fieldId: 'UF_CRM_CONTRACT_NUMBER',
                  categoryId: 69,
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.item.mode, result.item.requiredStageIds)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getRequirement)
        </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.smartprocess1038.field.required.get"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "fieldId": "UF_CRM_CONTRACT_NUMBER",
                    "categoryId": 69,
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result["item"]["mode"], result["item"]["requiredStageIds"])
        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}")

The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.smartprocess1038.field.required.get',
                    [
                        'fieldId' => 'UF_CRM_CONTRACT_NUMBER',
                        'categoryId' => 69,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.

BX24.callMethod(
            'crm.smartprocess1038.field.required.get',
            {
                fieldId: 'UF_CRM_CONTRACT_NUMBER',
                categoryId: 69,
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.smartprocess1038.field.required.get',
            [
                'fieldId' => 'UF_CRM_CONTRACT_NUMBER',
                'categoryId' => 69,
            ]
        );
        
        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.smartprocess1038.field.required.get", b24.Params{
        	"fieldId":    "UF_CRM_CONTRACT_NUMBER",
        	"categoryId": 69,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.field.required.get: %w", err)
        }
        
        var out struct {
        	Item struct {
        		FieldID          string   `json:"fieldId"`
        		Mode             string   `json:"mode"`
        		RequiredStageIDs []string `json:"requiredStageIds"`
        	} `json:"item"`
        }
        if err := json.Unmarshal(res.Result, &out); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(out.Item.Mode, out.Item.RequiredStageIDs)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "fieldId": "UF_CRM_CONTRACT_NUMBER",
                    "categoryId": 69,
                    "mode": "stages",
                    "requiredStageIds": [
                        "DT1038_69:CLIENT"
                    ],
                    "globallyRequired": false
                }
            },
            "time": {
                "start": 1793716021,
                "finish": 1793716021.25784,
                "duration": 0.2578399181365967,
                "processing": 0,
                "date_start": "2026-11-03T17:27:01+03:00",
                "date_finish": "2026-11-03T17:27:01+03:00",
                "operating_reset_at": 1793716620,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with response data
result.item `object`	Field requirement configuration. Configuration fields
time `time`	Information about the request execution time

Configuration Fields

Name `type`	Description
fieldId `string`	Field name
categoryId `integer`	Pipeline ID. For leads and estimates, `null`
mode `string`	Requirement mode. Possible values: `none` — the field is not required `all` — the field is required at all stages of the pipeline `stages` — the field is required at the stages from `requiredStageIds`
requiredStageIds `string[]`	Stages at which the field is required. The array is filled in only when `mode` = `stages`
globallyRequired `boolean`	Whether the field is required in all pipelines regardless of `mode`. For a custom field, `true` if `isMandatory` is `true` in its settings

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "Invalid category ID.",
                        "field": "categoryId"
                    }
                ]
            }
        }

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

The "Pipeline Not Found" error is returned with the short code CONTEXT_NOT_FOUND without the BITRIX_REST_V3_ prefix. Its text and the texts of validation errors are in English.

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`fieldId`	fieldId must be a non-empty string.	Pass the field name as a string, for example, `"UF_CRM_CONTRACT_NUMBER"`
`categoryId`	Invalid category ID.	Pass `categoryId` according to the parameter table
`categoryId`	categoryId must be a non-negative integer.	Pass the pipeline ID as an integer of `0` or greater

Field Not Found

Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION, HTTP status: 404

Field	Error description	How to Fix
`-`	Field `#FIELD#` was not found	Check the field name with the crm.<type>.field.list method. Standard field names are written in camelCase: `title`, not `TITLE`

Pipeline Not Found

Error Code: CONTEXT_NOT_FOUND, HTTP status: 404

Field	Error description	How to Fix
`-`	The field requirement context was not found.	Check `categoryId` against the parameter table

Access Denied

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP status: 403

Field	Error description	How to Fix
`-`	Access denied	Call the method on behalf of a user with the "Edit CRM preferences" permission in CRM

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.smartinvoice.field.required.get`. For an SPA, check `entityTypeId` with the crm.type.list method. My company does not have these methods

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

Was the article helpful?

Delete a List Field Option

Make a Field Required

Get a Field Requirement v 3.0 crm.[type].field.required.get

Method Name for the Object TypeMethod Name for the Object Type

Method ParametersMethod Parameters

The categoryId ParameterThe categoryId Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Configuration FieldsConfiguration Fields

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Field Not FoundField Not Found

Pipeline Not FoundPipeline Not Found

Access DeniedAccess Denied

Method Not FoundMethod Not Found

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Name for the Object Type

Method Parameters

The categoryId Parameter

Code Examples

Response Handling

Returned Data

Configuration Fields

Error Handling

Possible Error Codes

Request Validation Errors

Field Not Found

Pipeline Not Found

Access Denied

Method Not Found

Statuses and System Error Codes

Continue Learning