Get a list of custom fields for contacts crm.contact.userfield.list

Scope: crm

Who can execute the method: administrator

The method crm.contact.userfield.list returns a list of custom fields for contacts based on a filter.

It also outputs information about these fields, but without the name assigned to the field by the user, only the internal identifier. If you need the user-defined field name, use the method crm.contact.list, which outputs both standard and custom fields.

Method Parameters

Name
type

Description

filter
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — the name of the field by which the selection of custom fields will be filtered
value_n — the filter value (only exact matches are available)

All conditions for individual fields are combined using AND. See the list of available fields for filtering below

order
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — the name of the field by which the selection of elements will be sorted
value_n — a string value equal to:
- ASC — ascending sort
- DESC — descending sort

Available fields for sorting:

ID — identifier of the custom field
FIELD_NAME — code of the custom field
USER_TYPE_ID — type of the custom field
XML_ID — external code
SORT — sort index

By default:

{
            "SORT": "ASC",
            "ID": "ASC"
        }

Available Fields for Filtering

Name `type`	Description
ID `integer`	Identifier of the custom field
FIELD_NAME `string`	Code of the custom field
USER_TYPE_ID `string`	Type of the custom field. Possible values: `string` — string `integer` — integer `double` — number `boolean` — yes/no `datetime` — date/time `date` — date `money` — money `url` — link `address` — address `enumeration` — list `file` — file `employee` — binding to an employee `crm_status` — binding to the CRM directory `iblock_section` — binding to information block sections `iblock_element` — binding to information block elements `crm` — binding to CRM elements custom field types
XML_ID `string`	External code
SORT `integer`	Sort index
MULTIPLE `boolean`	Is the custom field multiple (`Y` — yes / `N` — no)
MANDATORY `boolean`	Is the custom field mandatory (`Y` — yes / `N` — no)
SHOW_FILTER `char`	Show in the list filter. Possible values: `N` — do not show `I` — exact match `E` — mask `S` — substring
SHOW_IN_LIST `boolean`	Show in the list (`Y` — yes / `N` — no). This parameter does not affect anything within `crm`
EDIT_IN_LIST `boolean`	Allow user editing (`Y` — yes / `N` — no)
IS_SEARCHABLE `boolean`	Are field values included in the search (`Y` — yes / `N` — no) This parameter does not affect anything within `crm`
LANG `string`	Language identifier. When filtering by this parameter, a set of fields with values in the provided language will be returned: `EDIT_FORM_LABEL` — label in the edit form `LIST_COLUMN_LABEL` — header in the list `LIST_FILTER_LABEL` — filter label in the list `ERROR_MESSAGE` — error message `HELP_MESSAGE` — help

Code Examples

How to Use Examples in Documentation

Get a list of custom fields that:

are multiple
are mandatory
have custom field labels in German

Set the following sort order for this selection: field type and sort index in ascending order.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"MULTIPLE":"Y","MANDATORY":"Y","LANG":"de"},"order":{"USER_TYPE_ID":"ASC","SORT":"ASC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.userfield.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"MULTIPLE":"Y","MANDATORY":"Y","LANG":"de"},"order":{"USER_TYPE_ID":"ASC","SORT":"ASC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.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(
            'crm.contact.userfield.list',
            {
              filter: {
                MULTIPLE: "Y",
                MANDATORY: "Y",
                LANG: "de",
              },
              order: {
                USER_TYPE_ID: "ASC",
                SORT: "ASC",
              },
            },
            (progress) => { 
              result.error()
                ? console.error(result.error())
                : console.info(result.data())
              ;
            }
          );
          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('crm.contact.userfield.list', {
            filter: {
              MULTIPLE: "Y",
              MANDATORY: "Y",
              LANG: "de",
            },
            order: {
              USER_TYPE_ID: "ASC",
              SORT: "ASC",
            },
          }, '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('crm.contact.userfield.list', {
            filter: {
              MULTIPLE: "Y",
              MANDATORY: "Y",
              LANG: "de",
            },
            order: {
              USER_TYPE_ID: "ASC",
              SORT: "ASC",
            },
          }, 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(
                    'crm.contact.userfield.list',
                    [
                        'filter' => [
                            'MULTIPLE' => 'Y',
                            'MANDATORY' => 'Y',
                            'LANG' => 'de',
                        ],
                        'order' => [
                            'USER_TYPE_ID' => 'ASC',
                            'SORT' => 'ASC',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching user fields: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.contact.userfield.list',
            {
                filter: {
                    MULTIPLE: "Y",
                    MANDATORY: "Y",
                    LANG: "de",
                },
                order: {
                    USER_TYPE_ID: "ASC",
                    SORT: "ASC",
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.userfield.list',
            [
                'filter' => [
                    'MULTIPLE' => "Y",
                    'MANDATORY' => "Y",
                    'LANG' => "de",
                ],
                'order' => [
                    'USER_TYPE_ID' => "ASC",
                    'SORT' => "ASC",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                "ID": "474",
                "ENTITY_ID": "CRM_CONTACT",
                "FIELD_NAME": "UF_CRM_1724412832",
                "USER_TYPE_ID": "address",
                "XML_ID": null,
                "SORT": "300",
                "MULTIPLE": "Y",
                "MANDATORY": "Y",
                "SHOW_FILTER": "E",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "SHOW_MAP": "Y"
                },
                "EDIT_FORM_LABEL": "Custom Field (Address)",
                "LIST_COLUMN_LABEL": "Custom Field (Address)",
                "LIST_FILTER_LABEL": "Custom Field (Address)",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                },
                {
                "ID": "475",
                "ENTITY_ID": "CRM_CONTACT",
                "FIELD_NAME": "UF_CRM_1724412867",
                "USER_TYPE_ID": "crm",
                "XML_ID": null,
                "SORT": "1400",
                "MULTIPLE": "Y",
                "MANDATORY": "Y",
                "SHOW_FILTER": "I",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "CONTACT": "Y",
                    "COMPANY": "Y",
                    "DYNAMIC_1224": "Y",
                    "DYNAMIC_1226": "Y",
                    "DYNAMIC_1268": "Y",
                    "DYNAMIC_1278": "Y",
                    "LEAD": null
                },
                "EDIT_FORM_LABEL": "Custom Field (Binding to CRM Elements)",
                "LIST_COLUMN_LABEL": "Custom Field (Binding to CRM Elements)",
                "LIST_FILTER_LABEL": "Custom Field (Binding to CRM Elements)",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                },
                {
                "ID": "472",
                "ENTITY_ID": "CRM_CONTACT",
                "FIELD_NAME": "UF_CRM_1724412764",
                "USER_TYPE_ID": "date",
                "XML_ID": null,
                "SORT": "2000",
                "MULTIPLE": "Y",
                "MANDATORY": "Y",
                "SHOW_FILTER": "E",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "DEFAULT_VALUE": {
                    "VALUE": "2024-08-22",
                    "TYPE": "FIXED"
                    }
                },
                "EDIT_FORM_LABEL": "Custom Field (Date)",
                "LIST_COLUMN_LABEL": "Custom Field (Date)",
                "LIST_FILTER_LABEL": "Custom Field (Date)",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                },
                {
                "ID": "471",
                "ENTITY_ID": "CRM_CONTACT",
                "FIELD_NAME": "UF_CRM_1724412713",
                "USER_TYPE_ID": "double",
                "XML_ID": null,
                "SORT": "1500",
                "MULTIPLE": "Y",
                "MANDATORY": "Y",
                "SHOW_FILTER": "E",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "PRECISION": 2,
                    "SIZE": 20,
                    "MIN_VALUE": 0,
                    "MAX_VALUE": 0,
                    "DEFAULT_VALUE": 150
                },
                "EDIT_FORM_LABEL": "Custom Field (Number)",
                "LIST_COLUMN_LABEL": "Custom Field (Number)",
                "LIST_FILTER_LABEL": "Custom Field (Number)",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                },
                {
                "ID": "473",
                "ENTITY_ID": "CRM_CONTACT",
                "FIELD_NAME": "UF_CRM_1724412805",
                "USER_TYPE_ID": "employee",
                "XML_ID": null,
                "SORT": "800",
                "MULTIPLE": "Y",
                "MANDATORY": "Y",
                "SHOW_FILTER": "I",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": [],
                "EDIT_FORM_LABEL": "Custom Field (Employee)",
                "LIST_COLUMN_LABEL": "Custom Field (Employee)",
                "LIST_FILTER_LABEL": "Custom Field (Employee)",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                },
                {
                "ID": "476",
                "ENTITY_ID": "CRM_CONTACT",
                "FIELD_NAME": "UF_CRM_1724412914",
                "USER_TYPE_ID": "file",
                "XML_ID": null,
                "SORT": "1200",
                "MULTIPLE": "Y",
                "MANDATORY": "Y",
                "SHOW_FILTER": "N",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "SIZE": 20,
                    "LIST_WIDTH": 0,
                    "LIST_HEIGHT": 0,
                    "MAX_SHOW_SIZE": 0,
                    "MAX_ALLOWED_SIZE": 0,
                    "EXTENSIONS": [],
                    "TARGET_BLANK": "Y"
                },
                "EDIT_FORM_LABEL": "Custom Field (File)",
                "LIST_COLUMN_LABEL": "Custom Field (File)",
                "LIST_FILTER_LABEL": "Custom Field (File)",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                }
            ],
            "total": 6,
            "time": {
                "start": 1724435524.016968,
                "finish": 1724435527.855702,
                "duration": 3.8387339115142822,
                "processing": 0.366832971572876,
                "date_start": "2024-08-23T19:52:04+02:00",
                "date_finish": "2024-08-23T19:52:07+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `userfield[]`	Root element of the response, contains a list of custom fields. The structure of an individual custom field is identical to `userfield` except that the fields: `EDIT_FORM_LABEL`, `LIST_COLUMN_LABEL`, `LIST_FILTER_LABEL`, `ERROR_MESSAGE`, `HELP_MESSAGE` are returned either as `string` when passing `filter.LANG`, or are not returned at all
total `integer`	Number of found custom fields
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Parameter 'filter' must be array."
        }

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
`-`	`Parameter 'order' must be array`	The provided `order` is not an object
`-`	`Parameter 'filter' must be array`	The provided `filter` is not an object
`-`	`Access denied`	The user does not have administrative rights

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

Retrieve a Custom Field for Contacts by Id

Delete a Custom Field for Contacts

Get a list of custom fields for contacts crm.contact.userfield.list

Method ParametersMethod Parameters

Available Fields for FilteringAvailable Fields for Filtering

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