Get List of Service Fields v 3.0 catalog.product.service.field.list

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.product.service.field.list method returns the list of available service fields.

Method Parameters

Name
type

Description

select
array

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

Available fields:

name — field name
type — data type
title — title
description — description
validationRules — validation rules
requiredGroups — required groups
filterable — whether the field is available for filtering
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 value is multiple
elementType — element type for composite fields

Default: all description properties

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.product.service.field.list

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 '{"select":["name","type","requiredGroups","editableGroups"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.service.field.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["name","type","requiredGroups","editableGroups"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.product.service.field.list

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type ServiceFieldListResult = {
          items: Array<{
            name?: string
            type?: string
            requiredGroups?: string[] | null
            editableGroups?: string[] | null
          }>
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ServiceFieldListResult>({
            method: 'catalog.product.service.field.list',
            params: {
              select: ['name', 'type', 'requiredGroups', 'editableGroups'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Fields:', result.items.length)
          }
        } 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 listServiceFields() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.product.service.field.list',
                params: {
                  select: ['name', 'type', 'requiredGroups', 'editableGroups'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Fields:', result.items.length)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listServiceFields)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.service.field.list(
                select=["name", "type", "requiredGroups", "editableGroups"],
            ).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.product.service.field.list',
                    [
                        'select' => ['name', 'type', 'requiredGroups', 'editableGroups'],
                    ]
                );
        
            $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.product.service.field.list',
            {
                select: ['name', 'type', 'requiredGroups', 'editableGroups'],
            },
            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.product.service.field.list',
            [
                'select' => ['name', 'type', 'requiredGroups', 'editableGroups'],
            ]
        );
        
        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.product.service.field.list", b24.Params{
        	"select": []string{"name", "type", "requiredGroups", "editableGroups"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.product.service.field.list: %w", err)
        }
        
        var result struct {
        	Items []struct {
        		Name string `json:"name"`
        		Type string `json:"type"`
        	} `json:"items"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, field := range result.Items {
        	fmt.Println(field.Name, field.Type)
        }

Response Handling

HTTP status: 200

The method returns descriptions of 48 fields. The example shows the first four.

{
            "result": {
                "items": [
                    {
                        "name": "id",
                        "type": "int",
                        "requiredGroups": null,
                        "editableGroups": null
                    },
                    {
                        "name": "iblockId",
                        "type": "int",
                        "requiredGroups": [
                            "add"
                        ],
                        "editableGroups": [
                            "add"
                        ]
                    },
                    {
                        "name": "name",
                        "type": "string",
                        "requiredGroups": [
                            "add"
                        ],
                        "editableGroups": [
                            "add",
                            "update"
                        ]
                    },
                    {
                        "name": "code",
                        "type": "string",
                        "requiredGroups": null,
                        "editableGroups": [
                            "add",
                            "update"
                        ]
                    }
                ]
            },
            "time": {
                "start": 1792660853,
                "finish": 1792660853.574755,
                "duration": 0.5747549533843994,
                "processing": 0,
                "date_start": "2026-10-22T12:20:53+02:00",
                "date_finish": "2026-10-22T12:20:53+02:00",
                "operating_reset_at": 1792661400,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	An object with the response data
result.items `array`	An array of field descriptions: `id`, `iblockId`, `name`, `code`, `xmlId`, `active`, `sort`, `createdBy`, `modifiedBy`, `dateCreate`, `timestampX`, `dateActiveFrom`, `dateActiveTo`, `previewText`, `previewTextType`, `previewPicture`, `detailText`, `detailTextType`, `detailPicture`, `iblockSectionId`, `iblockSection`, `type`, `available`, `bundle`, `quantity`, `quantityReserved`, `quantityTrace`, `canBuyZero`, `subscribe`, `vatId`, `vatIncluded`, `purchasingPrice`, `purchasingCurrency`, `barcodeMulti`, `weight`, `length`, `width`, `height`, `measure`, `recurSchemeLength`, `recurSchemeType`, `trialPriceId`, `withoutOrder`, `quantityTraceRaw`, `paymentType`, `subscribeRaw`, `canBuyZeroRaw`, `properties`. The content of each description depends on `select`. Element description
time `time`	Information about the request execution time

Items Element

Name `type`	Description
name `string`	Field name
type `string`	Type in the metadata: `int`, `string`, `float`, `array`, `object`. For date fields and picture fields, `object` is returned
title `string`	Field title. Matches `name`
description `string`	Field description. `null` for service fields
validationRules `array`	Validation rules. An empty array for service fields
requiredGroups `array`	Operations in which the field is required. `["add"]` for `iblockId` and `name`, `null` for the other fields
filterable `boolean`	`true` — the field is available for filtering, `false` — it is not
sortable `boolean`	`true` — the field is available for sorting, `false` — it is not
editable `boolean`	`true` — the field can be passed in the operations from `editableGroups`, `false` — it cannot
editableGroups `array`	Operations in which the field can be set: `add`, `update`. Only `add` for `iblockId`. `null` for read-only fields
multiple `boolean`	Multiple value flag in the metadata. `false` for all fields
elementType `string`	Element type of a composite field. `null` for all fields

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
                "message": "Unknown field \"foo\" found in entity \"DtoFieldDto\"."
            }
        }

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

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 the properties from the `select` parameter description in `select`

`select` Format Errors

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"]`

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP status: 403

Field	Error description	How to Fix
`-`	Access denied	Check the user's permissions and the `catalog` scope

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 Service Fields by Filter

Get Service Field

Get List of Service Fields v 3.0 catalog.product.service.field.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Items ElementItems Element

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Errors in the ParameterErrors in the select Parameter

Format Errorsselect Format Errors

Access ErrorAccess Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Items Element

Error Handling

Possible Error Codes

Errors in the `select` Parameter

`select` Format Errors

Access Error

Statuses and System Error Codes

Continue Learning