Get List of Inventory Document Custom Field Values v 3.0 catalog.document.userfield.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: a user with the "View" permission for documents of this type and the "View product catalog" and "View Inventory Management area" permissions

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 method catalog.document.userfield.list returns the custom field values of inventory documents of one type.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter*
array

Filter in REST 3.0 format: an array of conditions of the form ["field", "operator", "value"], for example [["docType", "=", "A"], ["id", "=", 325]]. The filter syntax is described in the REST 3.0 overview.

The condition ["docType", "=", "<type>"] with the = operator is required. Possible type values are returned by the catalog.document.type.list method. For a type that does not exist, the method returns an empty list.

Besides docType, you can filter by id. Filtering by userFields, condition groups with or logic, and negation are not supported

select
array

Array of fields to return in the response.

Available fields:

  • id — document identifier
  • docType — document type
  • userFields — custom field values

The value ["*"] is not supported.

By default: all fields

order
object

Sorting in the format {"field": "direction"}, for example {"id": "desc"}.

Possible direction values:

  • asc — ascending
  • desc — descending

You can sort by id and docType

pagination
object

Pagination. Object description

Parameter Pagination

Name
type

Description

limit
integer

Number of records per page. Values greater than 1000 are reduced to 1000, the value 0 causes an error.

By default: 50

page
integer

Page number, starting from 1. If passed, it replaces offset. A page beyond the end of the list returns an empty array

offset
integer

Number of records to skip

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.document.userfield.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":[["docType","=","A"],["id","=",325]],"select":["id","docType","userFields"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.userfield.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":[["docType","=","A"],["id","=",325]],"select":["id","docType","userFields"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.document.userfield.list
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type DocumentUserfieldListResult = {
          items: Array<{
            id?: number
            docType?: string
            userFields?: Record<string, unknown> | null
          }>
        }
        
        try {
          const response = await $b24.actions.v3.call.make<DocumentUserfieldListResult>({
            method: 'catalog.document.userfield.list',
            params: {
              filter: [
                ['docType', '=', 'A'],
                ['id', '=', 325],
              ],
              select: ['id', 'docType', 'userFields'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Documents:', result.items)
          }
        } 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 documentUserfieldList() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.document.userfield.list',
                params: {
                  filter: [
                    ['docType', '=', 'A'],
                    ['id', '=', 325],
                  ],
                  select: ['id', 'docType', 'userFields'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Documents:', result.items)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', documentUserfieldList)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.document.userfield.list(
                filter=[
                    ["docType", "=", "A"],
                    ["id", "=", 325],
                ],
                select=["id", "docType", "userFields"],
            ).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.document.userfield.list',
                    [
                        'filter' => [
                            ['docType', '=', 'A'],
                            ['id', '=', 325],
                        ],
                        'select' => ['id', 'docType', 'userFields'],
                    ]
                );
        
            $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.document.userfield.list',
            {
                filter: [
                    ['docType', '=', 'A'],
                    ['id', '=', 325],
                ],
                select: ['id', 'docType', 'userFields'],
            },
            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.document.userfield.list',
            [
                'filter' => [
                    ['docType', '=', 'A'],
                    ['id', '=', 325],
                ],
                'select' => ['id', 'docType', 'userFields'],
            ]
        );
        
        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.document.userfield.list", b24.Params{
        	"filter": []any{
        		[]any{"docType", "=", "A"},
        		[]any{"id", "=", 325},
        	},
        	"select": []string{"id", "docType", "userFields"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.document.userfield.list: %w", err)
        }
        
        var result struct {
        	Items []struct {
        		ID         int                        `json:"id"`
        		DocType    string                     `json:"docType"`
        		UserFields map[string]json.RawMessage `json:"userFields"`
        	} `json:"items"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, item := range result.Items {
        	fmt.Println(item.ID, item.DocType, len(item.UserFields))
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "id": 325,
                        "docType": "A",
                        "userFields": {
                            "UF_CAT_STORE_DOCUMENT_A_REST_TEST": "1"
                        }
                    }
                ]
            },
            "time": {
                "start": 1792665383,
                "finish": 1792665383.478756,
                "duration": 0.4787559509277344,
                "processing": 0,
                "date_start": "2026-10-22T13:36:23+02:00",
                "date_finish": "2026-10-22T13:36:23+02:00",
                "operating_reset_at": 1792665960,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.items
array

Array of documents. The set of fields depends on select. Field description

time
time

Information about the request execution time

Items Element

Name
type

Description

id
integer

Document identifier

docType
string

Document type

userFields
object or null

Custom field values of the document. The keys are field codes of the form UF_*, for example UF_CAT_STORE_DOCUMENT_A_REST_TEST.

null if documents of this type have no custom fields

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "The docType field is not specified in the filter parameter"
                    }
                ]
            }
        }
        

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

filter

The docType field is not specified in the filter parameter

Add the condition ["docType", "=", "<type>"] to filter. The in operator is not supported for docType

filter

Filter OR groups are not supported

Remove groups with or logic from filter

userFields

DTO UserfieldDocumentDto in field userFields requires attribute Filterable to perform this request

Remove userFields from filter

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

select, filter, order

Unknown field #FIELD# found in entity UserfieldDocumentDto

Specify only fields from the select parameter description

Pagination Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field

Error description

How to Fix

pagination

Incorrect pagination parameter value: {"limit":0}

Pass a number from 1 to 1000 in limit

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Check the user's permissions for documents of this type and for the Inventory Management section

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