Get a Field Description v 3.0 crm.[type].field.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 read items of this CRM object type

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.get method returns the description of a single field of a CRM object type by name. 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.get`	Deal fields
Lead	`crm.lead.field.get`	Lead fields
Contact	`crm.contact.field.get`	Contact fields
Company	`crm.company.field.get`	Company fields
Estimate	`crm.quote.field.get`	Estimate fields
Invoice	`crm.smartinvoice.field.get`	Invoice fields
My company	`crm.mycompany.field.get`	My company fields
SPA	`crm.smartprocess<entityTypeId>.field.get`, for example, `crm.smartprocess1038.field.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 description methods regardless of the type settings.

The method name is written in lowercase: crm.smartinvoice.field.get, not crm.smartInvoice.field.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

name*
string

Field name in camelCase, for example, stageId, or a custom field name, for example, UF_CRM_CONTRACT_NUMBER. The method does not find standard fields written in uppercase, for example, TITLE. The list of names is returned by the crm.<type>.field.list method

select
array

List of description fields to return, for example, ["name", "type", "editable"]. Description fields.

By default, the method returns all description fields

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.get

The examples retrieve the description of the stage field 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 '{"name":"stageId"}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"name":"stageId","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.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 FieldGetResult = {
          item: {
            name: string
            type: string
            title: string
            multiple: boolean
            editable: boolean
          }
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<FieldGetResult>(
            'crm.smartprocess1038.field.get',
            {
              name: 'stageId',
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.item.name, result.item.type, result.item.editable)
          }
        } 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 getField() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.field.get',
                {
                  name: 'stageId',
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.item.name, result.item.type, result.item.editable)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getField)
        </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.get"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "name": "stageId",
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result["item"])
        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.get',
                    [
                        'name' => 'stageId',
                    ]
                );
        
            $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.get',
            {
                name: 'stageId',
            },
            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.get',
            [
                'name' => 'stageId',
            ]
        );
        
        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.get", b24.Params{
        	"name": "stageId",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.field.get: %w", err)
        }
        
        var out struct {
        	Item struct {
        		Name     string `json:"name"`
        		Type     string `json:"type"`
        		Editable bool   `json:"editable"`
        	} `json:"item"`
        }
        if err := json.Unmarshal(res.Result, &out); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(out.Item.Name, out.Item.Type, out.Item.Editable)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "name": "stageId",
                    "type": "string",
                    "elementType": null,
                    "multiple": false,
                    "title": "Stage",
                    "description": null,
                    "validationRules": [],
                    "requiredGroups": null,
                    "filterable": true,
                    "sortable": true,
                    "editable": true
                }
            },
            "time": {
                "start": 1793715000,
                "finish": 1793715000.500155,
                "duration": 0.500154972076416,
                "processing": 0,
                "date_start": "2026-11-03T17:10:00+03:00",
                "date_finish": "2026-11-03T17:10:00+03:00",
                "operating_reset_at": 1793715600,
                "operating": 0
            }
        }

Returned Data

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

Description Fields

Name `type`	Description
name `string`	Field name: in camelCase for a standard field, for example, `title`, and in the `UF_CRM_…` format for a custom field
type `string`	Data type, for example, `string`, `int`, `date-time`, `object`
elementType `string`	Element type for composite fields, for example, `object` for a related object. For simple fields, `null`
multiple `boolean`	Whether the field accepts multiple values
title `string`	Field title in the Bitrix24 language
description `string`	Field description. If there is no description, `null`
validationRules `array`	Value validation rules, for example, `{"name": "Length", "parameters": {"max": 255}}` — a length of no more than 255 characters
requiredGroups `array`	Methods that require this field, for example, `["add"]`. If there are no such methods, `null`. A requirement set with the crm.<type>.field.required.* methods is not shown here. The contact rule "`name` or `lastName`" is not shown here either: it is reported only by an error returned by crm.<type>.add
filterable `boolean`	Whether the field can be used for filtering in the crm.<type>.list method
sortable `boolean`	Whether the field can be used for sorting in the crm.<type>.list method
editable `boolean`	Whether the field can be passed in the crm.<type>.add and crm.<type>.update methods

Error Handling

HTTP status: 404

{
            "error": {
                "code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION",
                "message": "Field \"TITLE\" 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
`name`	Required field `name` is missing	Pass `name`
`name`	This request requires data type `string` in field `name`	Pass the field name as a string

Field Not Found

Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION, HTTP status: 404

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

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `CrmFieldMetadataDto`	Check the names in `select` against the description fields table

Select Format Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Field	Error description	How to Fix
`-`	Invalid field in `select`: `#VALUE#`	Pass `select` as an array, for example, `["name"]`, not as a string

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 permission to read items of this object type

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.get`. For an SPA, check `entityTypeId` with the crm.type.list method

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?

Overview of Methods

Get Field Descriptions

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

Method Name for the Object TypeMethod Name for the Object Type

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Description FieldsDescription Fields

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Field Not FoundField Not Found

Unknown Field ErrorUnknown Field Error

Select Format ErrorSelect Format Error

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

Code Examples

Response Handling

Returned Data

Description Fields

Error Handling

Possible Error Codes

Request Validation Errors

Field Not Found

Unknown Field Error

Select Format Error

Access Denied

Method Not Found

Statuses and System Error Codes

Continue Learning