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:
catalogWho 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 |
Description |
|
filter* |
Filter in REST 3.0 format: an array of conditions of the form The condition Besides |
|
select |
Array of fields to return in the response. Available fields:
The value By default: all fields |
|
order |
Sorting in the format Possible direction values:
You can sort by |
|
pagination |
Pagination. Object description |
Parameter Pagination
|
Name |
Description |
|
limit |
Number of records per page. Values greater than By default: |
|
page |
Page number, starting from |
|
offset |
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 |
Description |
|
result |
Object with the response data |
|
result.items |
Array of documents. The set of fields depends on |
|
time |
Information about the request execution time |
Items Element
|
Name |
Description |
|
id |
Document identifier |
|
docType |
Document type |
|
userFields |
Custom field values of the document. The keys are field codes of the form
|
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 |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
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 |
|
|
The docType field is not specified in the filter parameter |
Add the condition |
|
|
Filter OR groups are not supported |
Remove groups with |
|
|
DTO |
Remove |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Specify only fields from the |
Pagination Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Incorrect |
Pass a number from |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Update Inventory Document Custom Field Values v 3.0 catalog.document.userfield.update
- Get List of Fields for Document Custom Fields v 3.0 catalog.document.userfield.field.list
- Get List of Inventory Documents v 3.0 catalog.document.list
- Custom Fields for Inventory Accounting Documents: Overview of Methods