Get a list of custom fields user.userfield.list

Scope: user.userfield

Who can execute the method: administrator

The method user.userfield.list retrieves a list of custom fields based on the filter.

Method Parameters

Name
type

Description

order
string|array

Sorting of the selected custom fields in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field_N:

ID — identifier of the custom field
FIELD_NAME — name of the field
USER_TYPE_ID — data type of the field
XML_ID — external code
SORT — sorting order of the field
MULTIPLE — ability to input multiple values
MANDATORY — requirement for filling
SHOW_FILTER — display of the field in the user list filter
SHOW_IN_LIST — display of the field in the user list
EDIT_IN_LIST — ability to edit the field in the user list
IS_SEARCHABLE — ability to search by the field

Possible values for order_N:

asc — in ascending order
desc — in descending order

filter
array

Filter for the selected custom fields in the format {"field_1": "value_1", ... "field_N": "value_N"}.

Possible values for field_N are similar to those in sorting.

An additional prefix can be assigned to the key to clarify the filter behavior. Possible prefix values:

>= — greater than or equal to
> — greater than
<= — less than or equal to
< — less than
@ — IN (an array is passed as the value)
!@ — NOT IN (an array is passed as the value)
% — LIKE, substring search. The % symbol should not be passed in the filter value. The search looks for the substring in any position of the string.
=% — LIKE, substring search. The % symbol should be passed in the value. Examples:
- "mol%" — searching for values starting with "mol"
- "%mol" — searching for values ending with "mol"
- "%mol%" — searching for values where "mol" can be in any position
%= — LIKE (similar to =%)
!% — NOT LIKE, substring search. The % symbol should not be passed in the filter value. The search goes from both sides.
!=% — NOT LIKE, substring search. The % symbol should be passed in the value. Examples:
- "mol%" — searching for values not starting with "mol"
- "%mol" — searching for values not ending with "mol"
- "%mol%" — searching for values where the substring "mol" is not present in any position
!%= — NOT LIKE (similar to !=%)
= — equal, exact match (used by default)
!= — not equal
! — not equal

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 '{"order":{"id":"desc"},"filter":{"id":13}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.userfield.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"id":"desc"},"filter":{"id":13},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/user.userfield.list

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'user.userfield.list',
            {
              order: {
                id: 'desc',
              },
              filter: {
                id: 13
              },
            },
            (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 it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('user.userfield.list', {
            order: {
              id: 'desc',
            },
            filter: {
              id: 13
            },
          }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('user.userfield.list', {
            order: {
              id: 'desc',
            },
            filter: {
              id: 13
            },
          }, 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(
                    'user.userfield.list',
                    [
                        'order' => [
                            'id' => 'desc',
                        ],
                        'filter' => [
                            'id' => 13
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching user fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "user.userfield.list",
            {
                order: {
                    id: 'desc',
                },
                filter: {
                    id: 13
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'user.userfield.list',
            [
                'order' => [
                    'id' => 'desc',
                ],
                'filter' => [
                    'id' => 13,
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result":[
                {
                    "ID":"176",
                    "ENTITY_ID":"USER",
                    "FIELD_NAME":"UF_USR_1724228142162",
                    "USER_TYPE_ID":"enumeration",
                    "XML_ID":null,
                    "SORT":"100",
                    "MULTIPLE":"Y",
                    "MANDATORY":"N",
                    "SHOW_FILTER":"E",
                    "SHOW_IN_LIST":"Y",
                    "EDIT_IN_LIST":"Y",
                    "IS_SEARCHABLE":"N",
                    "SETTINGS": {
                        "DISPLAY":"UI",
                        "LIST_HEIGHT":1,
                        "CAPTION_NO_VALUE":"",
                        "SHOW_NO_VALUE":"Y"
                    },
                    "LIST":[
                        {
                            "ID":"26",
                            "SORT":"0",
                            "VALUE":"1",
                            "DEF":"N",
                            "XML_ID":"2a53ce08b86a6aba152b1b19204fdef2"
                        },
                        {
                            "ID":"27",
                            "SORT":"100",
                            "VALUE":"2",
                            "DEF":"N",
                            "XML_ID":"292df2be1171ed6ab038996deac29ac8"
                        },
                        {
                            "ID":"28",
                            "SORT":"200",
                            "VALUE":"3",
                            "DEF":"N",
                            "XML_ID":"3c5af70eafbba79a6cf52e299ed75123"
                        }
                    ]
                },
                {
                    "ID":"177",
                    "ENTITY_ID":"USER",
                    "FIELD_NAME":"UF_USR_MONEY",
                    "USER_TYPE_ID":"money",
                    "XML_ID":null,
                    "SORT":"100",
                    "MULTIPLE":"N",
                    "MANDATORY":"N",
                    "SHOW_FILTER":"N",
                    "SHOW_IN_LIST":"Y",
                    "EDIT_IN_LIST":"Y",
                    "IS_SEARCHABLE":"N",
                    "SETTINGS": {
                        "DEFAULT_VALUE":""
                    }
                }
            ],
            "total":2,
            "time": {
                "start":1747313326.788124,
                "finish":1747313328.641663,
                "duration":1.853538990020752,
                "processing":0.011211156845092773,
                "date_start":"2025-05-15T14:48:46+02:00",
                "date_finish":"2025-05-15T14:48:48+02:00",
                "operating":0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
total `integer`	Total number of records found
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{	
           "error":"",
           "error_description":"Access denied."
        }

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

Possible Error Codes

Code	Description	Value
Empty string	Access denied.	A field with such `id` does not exist or access is denied
Empty string	ID is not defined or invalid	`id` is not specified or is invalid

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Delete Custom Field

Update Custom Field

Get a list of custom fields user.userfield.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