Get Margin Field catalog.extra.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: catalog

Who can execute the method: any user

The 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 catalog.extra.field.get method returns the description of a markup field by name.

Method Parameters

Required parameters are marked with *

Name
type

Description

name*
string

Name of the field whose description you want to retrieve.

Available fields:

id — markup identifier
name — markup name
percentage — markup value in percent

select
array

An array of strings with the names of description properties to return in the response.

Default: all description properties. The ["*"] value is not supported.

Available fields:

name — field name
type — data type
title — title
description — description
validationRules — validation rules
requiredGroups — required groups
filterable — whether the field is available in the filter
sortable — whether the field is available for sorting
editable — whether the field is editable
editableGroups — groups of operations in which the field is editable
multiple — whether the field has multiple values
elementType — element type for composite 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}/catalog.extra.field.get

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":"percentage","select":["name","type","title"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.extra.field.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"name":"percentage","select":["name","type","title"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.extra.field.get

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type ExtraFieldGetResult = {
          item: {
            name?: string
            type?: string
            title?: string
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ExtraFieldGetResult>({
            method: 'catalog.extra.field.get',
            params: {
              name: 'percentage',
              select: ['name', 'type', 'title'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Field description:', result.item)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<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.actions.v3.call.make({
                method: 'catalog.extra.field.get',
                params: {
                  name: 'percentage',
                  select: ['name', 'type', 'title'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Field description:', result.item)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getField)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.extra.field.get(
                name="percentage",
                select=["name", "type", "title"],
            ).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}")

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(
                    'catalog.extra.field.get',
                    [
                        'name' => 'percentage',
                        'select' => ['name', 'type', 'title'],
                    ]
                );
        
            $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: ' . $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(
            'catalog.extra.field.get',
            {
                name: 'percentage',
                select: ['name', 'type', 'title'],
            },
            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(
            'catalog.extra.field.get',
            [
                'name' => 'percentage',
                'select' => ['name', 'type', 'title'],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.extra.field.get", b24.Params{
        	"name":   "percentage",
        	"select": []string{"name", "type", "title"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.extra.field.get: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("the response has no item key")
        }
        
        var item struct {
        	Name  string `json:"name"`
        	Type  string `json:"type"`
        	Title string `json:"title"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parsing the response: %w", err)
        }
        fmt.Println(item.Name, item.Type)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "name": "percentage",
                    "type": "float",
                    "title": "percentage"
                }
            },
            "time": {
                "start": 1792668087,
                "finish": 1792668087.710391,
                "duration": 0.7103910446166992,
                "processing": 0,
                "date_start": "2026-10-22T14:21:27+02:00",
                "date_finish": "2026-10-22T14:21:27+02:00",
                "operating_reset_at": 1792668660,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with the response data
result.item `object`	Field description. The object properties depend on `select`
time `time`	Information about the request execution time

Item Object

The description depends on select. The table lists all properties that can be requested.

Name `type`	Description
name `string`	Field name: `id`, `name`, `percentage`
type `string`	Metadata type: `int`, `string`, `float`
title `string`	Field title. Matches `name`
description `string` or `null`	Field description. `null` for the fields of this object
validationRules `array`	Validation rules. For `name`, `[{}]`: a length limit of 50 characters, rule parameters are not serialized. For other fields, `[]`
requiredGroups `array` or `null`	Array of operation names for which the field is required. For all fields, `null`
filterable `boolean`	`true` if filtering is supported; `false` otherwise. For all fields, `true`
sortable `boolean`	`true` if sorting is supported; `false` otherwise. For all fields, `true`
editable `boolean`	`true` if the field can be passed when writing; `false` otherwise. For all fields, `false`
editableGroups `array` or `null`	Array of operation names in which the field can be set. For all fields, `null`
multiple `boolean`	`true` for multiple values; `false` for a single value. For all fields, `false`
elementType `string` or `null`	Type of an element in a composite field. For all fields, `null`

Error Handling

HTTP status: 404

{
            "error": {
                "code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION",
                "message": "Field \"foo\" 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 the `name` parameter with an existing field name

Field Not Found Error

Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

HTTP status: 404.

Field	Error description	How to Fix
`name`	Field `#FIELD#` was not found	Specify a field name from the list: `id`, `name`, `percentage`

Errors in the `select` Parameter

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`select`	Unknown field `#FIELD#` found in entity `DtoFieldDto`	Pass only fields from the list: `name`, `type`, `title`, `description`, `validationRules`, `requiredGroups`, `filterable`, `sortable`, `editable`, `editableGroups`, `multiple`, `elementType`

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Field	Error description	How to Fix
`select`	Invalid field in `select`: `#SELECT#`	Pass `select` as an array of strings, for example `["name","type"]`

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?

Get list of margin fields v 3.0

Overview of Methods and Events

Get Margin Field catalog.extra.field.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Item ObjectItem Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Field Not Found ErrorField Not Found Error

Errors in the ParameterErrors in the select Parameter

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Item Object

Error Handling

Possible Error Codes

Request Validation Errors

Field Not Found Error

Errors in the `select` Parameter

Statuses and System Error Codes

Continue Learning