Get a List of Custom Field Values for Inventory Accounting Documents catalog.userfield.document.list

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: catalog

Who can execute the method: a user with the "View Product Catalog" access permission

The method catalog.userfield.document.list returns a paginated list of custom field values for inventory accounting documents.

Method Parameters

Required parameters are marked with *

Name `type`	Description
select* `array`	An array containing the list of fields to select (see the fields of the catalog_userfield_document object). Make sure to include `documentType` — the type of inventory accounting document
filter* `object`	An object for filtering the selected records in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field` correspond to the fields of the catalog_userfield_document object. You must specify `documentType` — the type of inventory accounting document. You can add an additional prefix to the key to clarify the filter's behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `%` — LIKE, substring search. The `%` symbol should not be included in the filter value `=%` — LIKE, substring search. The `%` symbol should be included in the value `%=` — LIKE (similar to `=%`) `!%` — NOT LIKE, substring search. The `%` symbol should not be included in the filter value `!=%` — NOT LIKE, substring search. The `%` symbol should be included in the value `!%=` — NOT LIKE (similar to `!=%`) `=` — equal, exact match, used by default `!=` — not equal `!` — not equal
order `object`	A sorting object in the format `{"field_1": "order_1", ..., "field_N": "order_N"}`. Possible values for `field` correspond to the fields of the catalog_userfield_document object. Possible values for `order`: `asc` — in ascending order `desc` — in descending order If the parameter is not provided, the sorting `documentId ASC` is applied
start `integer`	This parameter is used to manage pagination. The page size for results is always static — 50 records. To select the second page of results, pass the value `50`. To select the third page of results — the value `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` is the desired page number

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["documentType","documentId","field7097"],"filter":{"documentType":"A","documentId":81},"order":{"documentId":"ASC"},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.userfield.document.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["documentType","documentId","field7097"],"filter":{"documentType":"A","documentId":81},"order":{"documentId":"ASC"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.userfield.document.list

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory load.
        
        try {
        const response = await $b24.callListMethod(
            'catalog.userfield.document.list',
            {
            select: ['documentType', 'documentId', 'field7097'],
            filter: { documentType: 'A', documentId: 81 },
            order: { documentId: 'ASC' },
            start: 0
            },
            (progress) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use for large volumes of data for efficient memory consumption.
        
        try {
        const generator = $b24.fetchListMethod('catalog.userfield.document.list', {
            select: ['documentType', 'documentId', 'field7097'],
            filter: { documentType: 'A', documentId: 81 },
            order: { documentId: 'ASC' },
            start: 0
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // callMethod: Manual control of pagination through the start parameter. Use for precise control over request batches. Less efficient for large data than fetchListMethod.
        
        try {
        const response = await $b24.callMethod('catalog.userfield.document.list', {
            select: ['documentType', 'documentId', 'field7097'],
            filter: { documentType: 'A', documentId: 81 },
            order: { documentId: 'ASC' },
            start: 0
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.userfield.document.list',
                    [
                        'select' => ['documentType', 'documentId', 'field7097'],
                        'filter' => ['documentType' => 'A', 'documentId' => 81],
                        'order' => ['documentId' => 'ASC'],
                        'start' => 0
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (\Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'catalog.userfield.document.list',
            {
                select: ['documentType', 'documentId', 'field7097'],
                filter: { documentType: 'A', documentId: 81 },
                order:  { documentId: 'ASC' }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
        
                    if (result.more()) {
                        result.next();
                    }
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.userfield.document.list',
            [
                'select' => ['documentType', 'documentId', 'field7097'],
                'filter' => ['documentType' => 'A', 'documentId' => 81],
                'order' => ['documentId' => 'ASC'],
                'start' => 0
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Code: 200

{
            "result": {
                "documents": [
                {
                    "documentId": 81,
                    "documentType": "A",
                    "field7097": "Test Field"
                }
                ]
            },
            "total": 1,
            "time": {
                "start": 1774343822,
                "finish": 1774343822.822166,
                "duration": 0.8221659660339355,
                "processing": 0,
                "date_start": "2026-03-24T12:17:02+01:00",
                "date_finish": "2026-03-24T12:17:02+01:00",
                "operating_reset_at": 1774344422,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	The root element of the response
documents `catalog_userfield_document[]`	A list of objects with values of custom fields for documents. The composition of fields depends on the `select` parameter
next `integer`	Offset for the next page. This field is returned if there are more records
total `integer`	The total number of records. This field is not returned if the request is executed with `start = -1`
time `time`	Information about the execution time of the request

Error Handling

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

HTTP Code: 400

{
            "error": "0",
            "error_description": "The documentType field is not specified in the filter parameter"
        }

Possible Error Codes

Code	Description	Value
`0`	The documentType field is not specified in the select parameter	The `documentType` is not specified in the `select` parameter
`0`	The documentType field is not specified in the filter parameter	The `documentType` is not specified in the `filter` parameter
`0`	Access Denied	Insufficient rights to read the values of custom fields for documents

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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

Update Field Values

Overview of Methods

Get a List of Custom Field Values for Inventory Accounting Documents catalog.userfield.document.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning