Get Custom Deal Field by ID crm.deal.userfield.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: any user with "read" access permission for deals

DEPRECATED

The development of this method has been halted. Please use the REST 3.0 method crm.deal.field.custom.get.

The method crm.deal.userfield.get returns a custom deal field description by its identifier: name, type, settings, and labels in all languages.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the custom deal field.

The identifier can be obtained using the methods crm.deal.userfield.add or crm.deal.userfield.list

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6997}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.userfield.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6997,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.userfield.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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type CrmDealUserfield = {
          ID: string
          ENTITY_ID: string
          FIELD_NAME: string
          USER_TYPE_ID: string
          XML_ID: string | null
          SORT: string
          MULTIPLE: string
          MANDATORY: string
          SHOW_FILTER: string
          SHOW_IN_LIST: string
          EDIT_IN_LIST: string
          IS_SEARCHABLE: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CrmDealUserfield>({
            method: 'crm.deal.userfield.get',
            params: {
              id: 6997,
            },
            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('Userfield:', result.FIELD_NAME, result.USER_TYPE_ID)
          }
        } 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 getDealUserfield() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.deal.userfield.get',
                params: {
                  id: 6997,
                },
                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('Userfield:', result.FIELD_NAME, result.USER_TYPE_ID)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDealUserfield)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.deal.userfield.get(bitrix_id=6997).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.deal.userfield.get',
                    [
                        'id' => 6997,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'crm.deal.userfield.get',
            {
                id: 6997,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.userfield.get',
            [
                'id' => 6997
            ]
        );
        
        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.deal.userfield.get", b24.Params{
        	"id": 6997,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.deal.userfield.get: %w", err)
        }
        
        var item struct {
        	ID         b24.ID `json:"ID"`
        	EntityID   string `json:"ENTITY_ID"`
        	FieldName  string `json:"FIELD_NAME"`
        	UserTypeID string `json:"USER_TYPE_ID"`
        	Sort       string `json:"SORT"`
        	Multiple   string `json:"MULTIPLE"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.EntityID)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": "6997",
                "ENTITY_ID": "CRM_DEAL",
                "FIELD_NAME": "UF_CRM_HELLO_WORLD",
                "USER_TYPE_ID": "string",
                "XML_ID": null,
                "SORT": "2000",
                "MULTIPLE": "Y",
                "MANDATORY": "N",
                "SHOW_FILTER": "N",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "N",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "SIZE": 20,
                    "ROWS": 10,
                    "REGEXP": "",
                    "MIN_LENGTH": 0,
                    "MAX_LENGTH": 0,
                    "DEFAULT_VALUE": "Hello, World! Default value (changed)"
                },
                "EDIT_FORM_LABEL": {
                    "ar": "",
                    "br": "",
                    "de": "Hallo, Welt! Bearbeiten (geändert)",
                    "en": "Hello, World! Edit (changed)",
                    "fr": "",
                    "hi": "",
                    "id": "",
                    "in": "",
                    "it": "",
                    "ja": "",
                    "kz": "",
                    "la": "",
                    "ms": "",
                    "pl": "",
                    "ru": "",
                    "sc": "",
                    "tc": "",
                    "th": "",
                    "tr": "",
                    "ua": "",
                    "vn": ""
                },
                "LIST_COLUMN_LABEL": {
                    "ar": "",
                    "br": "",
                    "de": "Hallo, Welt! Spalte (geändert)",
                    "en": "Hello, World! Column (changed)",
                    "fr": "",
                    "hi": "",
                    "id": "",
                    "in": "",
                    "it": "",
                    "ja": "",
                    "kz": "",
                    "la": "",
                    "ms": "",
                    "pl": "",
                    "ru": "",
                    "sc": "",
                    "tc": "",
                    "th": "",
                    "tr": "",
                    "ua": "",
                    "vn": ""
                },
                "LIST_FILTER_LABEL": {
                    "ar": "",
                    "br": "",
                    "de": "Hallo, Welt! Filter (geändert)",
                    "en": "Hello, World! Filter (changed)",
                    "fr": "",
                    "hi": "",
                    "id": "",
                    "in": "",
                    "it": "",
                    "ja": "",
                    "kz": "",
                    "la": "",
                    "ms": "",
                    "pl": "",
                    "ru": "",
                    "sc": "",
                    "tc": "",
                    "th": "",
                    "tr": "",
                    "ua": "",
                    "vn": ""
                },
                "ERROR_MESSAGE": {
                    "ar": "",
                    "br": "",
                    "de": "Hallo, Welt! Fehler (geändert)",
                    "en": "Hello, World! Error (changed)",
                    "fr": "",
                    "hi": "",
                    "id": "",
                    "in": "",
                    "it": "",
                    "ja": "",
                    "kz": "",
                    "la": "",
                    "ms": "",
                    "pl": "",
                    "ru": "",
                    "sc": "",
                    "tc": "",
                    "th": "",
                    "tr": "",
                    "ua": "",
                    "vn": ""
                },
                "HELP_MESSAGE": {
                    "ar": "",
                    "br": "",
                    "de": "Hallo, Welt! Hilfe (geändert)",
                    "en": "Hello, World! Help (changed)",
                    "fr": "",
                    "hi": "",
                    "id": "",
                    "in": "",
                    "it": "",
                    "ja": "",
                    "kz": "",
                    "la": "",
                    "ms": "",
                    "pl": "",
                    "ru": "",
                    "sc": "",
                    "tc": "",
                    "th": "",
                    "tr": "",
                    "ua": "",
                    "vn": ""
                }
            },
            "time": {
                "start": 1753790529.430936,
                "finish": 1753790529.487882,
                "duration": 0.05694580078125,
                "processing": 0.0039789676666259766,
                "date_start": "2025-07-29T15:02:09+02:00",
                "date_finish": "2025-07-29T15:02:09+02:00",
                "operating_reset_at": 1753791129,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Custom field description (detailed description)

time
time

Information about the request execution time

result Object

Numeric values of ID and SORT are returned as strings.

Name
type

Description

ID
string

Custom field identifier

ENTITY_ID
string

The object the field belongs to. For deals, always CRM_DEAL

FIELD_NAME
string

Field name with the UF_CRM_ prefix. Deal methods use this name to write and read the field value, for example, crm.deal.update and crm.deal.get. The method itself does not return field values in deals

USER_TYPE_ID
string

Field type. For the list of values, see the USER_TYPE_ID parameter of the method crm.deal.userfield.add

USER_TYPE_OWNER
string

Identifier of the application that registered the custom field type. Returned only for fields of a custom type

XML_ID
string

External code. If not set, null

SORT
string

Sort index

MULTIPLE
char

Whether the field is multiple: Y or N

MANDATORY
char

Whether the field is required: Y or N

SHOW_FILTER
char

Whether to show the field in the list filter. Possible values:

  • N — do not show
  • I — exact match
  • E — mask
  • S — substring

SHOW_IN_LIST
char

Whether to show the field in the list: Y or N

EDIT_IN_LIST
char

Whether the user can edit the field: Y or N

IS_SEARCHABLE
char

Whether the field values are included in search: Y or N

SETTINGS
object

The full set of the field type settings. Besides the settings accepted by crm.deal.userfield.add, it may contain service keys of the type, for example, SIZE, MIN_LENGTH, and MAX_LENGTH for a string. The method crm.userfield.settings.fields returns the list of type settings

EDIT_FORM_LABEL
lang_map

Label in the edit form in all Bitrix24 languages

LIST_COLUMN_LABEL
lang_map

Column header in the list in all languages

LIST_FILTER_LABEL
lang_map

Filter label in all languages

ERROR_MESSAGE
lang_map

Error message in all languages

HELP_MESSAGE
lang_map

Help text in all languages

LIST
object[]

List items. Returned only for enumeration fields, sorted by SORT. Each item contains:

  • ID — item identifier; pass it as the field value when writing to a deal
  • SORT — sort index
  • VALUE — item value
  • DEF — whether the item is the default: Y or N

The method does not return the item external code XML_ID; crm.deal.userfield.list returns it

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "ID is not defined or invalid."
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

Empty value

ID is not defined or invalid.

The provided id is less than or equal to zero or not provided

400

Empty value

Access denied.

Occurs when:

  • the user does not have "read" access permission for deals
  • the field with the provided id belongs to another object, for example, leads

400

ERROR_NOT_FOUND

The entity with ID 'id' is not found.

The custom field with the provided id 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
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