Get a list of custom fields of the requisite by filter crm.requisite.userfield.list

Scope: crm

Who can execute the method: any user

The method returns a list of custom fields of the requisite based on the filter.

Method Parameters

Required parameters are marked with *

Name
type

Description

order
object

Object for sorting the selected custom fields in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field:

ID
ENTITY_ID
FIELD_NAME
USER_TYPE_ID
XML_ID
SORT

Possible values for order:

asc — in ascending order
desc — in descending order

filter
object

Object for filtering the selected requisites in the format {"field_1": "value_1", ... "field_N": "value_N"}. This method's filter only supports simple value comparisons.

Possible values for field:

ID
ENTITY_ID
FIELD_NAME
USER_TYPE_ID
XML_ID
SORT
MULTIPLE
MANDATORY
SHOW_FILTER
SHOW_IN_LIST
EDIT_IN_LIST
IS_SEARCHABLE
LANG

Additional prefixes in keys that clarify filter behavior are not provided. The equals operation is always used.

Possible values for value correspond to field descriptions

Description of custom field of requisite

Name `type`	Description
ID `int`	Identifier of the custom field
ENTITY_ID `string`	Identifier of the entity to which the custom field belongs. For requisites, this is always `CRM_REQUISITE`
FIELD_NAME^* `string`	Symbolic code. For requisites, it always starts with the prefix `UF_CRM_`
USER_TYPE_ID^* `string`	Data type (`string`, `boolean`, `double` or `datetime`)
XML_ID `string`	External key. Used for exchange operations. Identifier of the object in the external information base. The purpose of the field may change by the final developer
SORT `int`	Sorting
MULTIPLE `char`	Multiplicity indicator. Possible values: `Y` — yes `N` — no
MANDATORY `char`	Mandatory indicator. Possible values: `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 `char`	Show in the list. Possible values: `Y` — yes `N` — no
EDIT_IN_LIST `char`	Allow user editing. Possible values: `Y` — yes `N` — no
IS_SEARCHABLE `char`	Are field values included in search. Possible values: `Y` — yes `N` — no
EDIT_FORM_LABEL `string`	Label in the edit form
LIST_COLUMN_LABEL `string`	Header in the list
LIST_FILTER_LABEL `string`	Filter label in the list
ERROR_MESSAGE `string`	Error message
HELP_MESSAGE `string`	Help
LIST `uf_enum_element`	List elements. For detailed information, see the section Get Field Descriptions for Custom Field Type "Enumeration" (List) crm.userfield.enumeration.fields
SETTINGS `object`	Additional settings (depend on type). For detailed information, see the section Get the settings field descriptions for the custom field type crm.userfield.settings.fields

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":{"SORT":"ASC"},"filter":{"MANDATORY":"N","LANG":"en"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"SORT":"ASC"},"filter":{"MANDATORY":"N","LANG":"en"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.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.requisite.userfield.list',
            {
              order: { "SORT": "ASC" },
              filter: { "MANDATORY": "N", "LANG": "en" }
            },
            (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('crm.requisite.userfield.list', { order: { "SORT": "ASC" }, filter: { "MANDATORY": "N", "LANG": "en" } }, '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.requisite.userfield.list', { order: { "SORT": "ASC" }, filter: { "MANDATORY": "N", "LANG": "en" } }, 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.requisite.userfield.list',
                    [
                        'order' => ['SORT' => 'ASC'],
                        'filter' => ['MANDATORY' => 'N', 'LANG' => 'en']
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error listing requisite user fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.userfield.list",
            {
                order: { "SORT": "ASC" },
                filter: { "MANDATORY": "N", "LANG": "en" }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());
                    if(result.more())
                        result.next();
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.userfield.list',
            [
                'order' => ['SORT' => 'ASC'],
                'filter' => ['MANDATORY' => 'N', 'LANG': 'en']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                "ID": "232",
                "ENTITY_ID": "CRM_REQUISITE",
                "FIELD_NAME": "UF_CRM_NEWTECH_V1_BOOLEAN",
                "USER_TYPE_ID": "boolean",
                "XML_ID": null,
                "SORT": "100",
                "MULTIPLE": "N",
                "MANDATORY": "N",
                "SHOW_FILTER": "E",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "DEFAULT_VALUE": 0,
                    "DISPLAY": "CHECKBOX",
                    "LABEL": [
                    "",
                    ""
                    ],
                    "LABEL_CHECKBOX": "UF - Yes/No"
                },
                "EDIT_FORM_LABEL": "UF - Yes/No",
                "LIST_COLUMN_LABEL": "UF - Yes/No",
                "LIST_FILTER_LABEL": "UF - Yes/No",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                },
                {
                "ID": "233",
                "ENTITY_ID": "CRM_REQUISITE",
                "FIELD_NAME": "UF_CRM_NEWTECH_V1_DATETIME",
                "USER_TYPE_ID": "datetime",
                "XML_ID": null,
                "SORT": "100",
                "MULTIPLE": "N",
                "MANDATORY": "N",
                "SHOW_FILTER": "E",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "DEFAULT_VALUE": {
                    "TYPE": "NONE",
                    "VALUE": ""
                    },
                    "USE_SECOND": "Y",
                    "USE_TIMEZONE": "N"
                },
                "EDIT_FORM_LABEL": "UF - Date",
                "LIST_COLUMN_LABEL": "UF - Date",
                "LIST_FILTER_LABEL": "UF - Date",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                },
                {
                "ID": "234",
                "ENTITY_ID": "CRM_REQUISITE",
                "FIELD_NAME": "UF_CRM_NEWTECH_V1_DOUBLE",
                "USER_TYPE_ID": "double",
                "XML_ID": null,
                "SORT": "100",
                "MULTIPLE": "N",
                "MANDATORY": "N",
                "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": null
                },
                "EDIT_FORM_LABEL": "PP - Number",
                "LIST_COLUMN_LABEL": "PP - Number",
                "LIST_FILTER_LABEL": "PP - Number",
                "ERROR_MESSAGE": null,
                "HELP_MESSAGE": null
                },
                {
                "ID": "235",
                "ENTITY_ID": "CRM_REQUISITE",
                "FIELD_NAME": "UF_CRM_NEWTECH_V1_STRING",
                "USER_TYPE_ID": "string",
                "XML_ID": null,
                "SORT": "100",
                "MULTIPLE": "N",
                "MANDATORY": "N",
                "SHOW_FILTER": "N",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "SIZE": 20,
                    "ROWS": 1,
                    "REGEXP": "",
                    "MIN_LENGTH": 0,
                    "MAX_LENGTH": 0,
                    "DEFAULT_VALUE": ""
                },
                "EDIT_FORM_LABEL": "PP - String",
                "LIST_COLUMN_LABEL": "PP - String",
                "LIST_FILTER_LABEL": "PP - String",
                "ERROR_MESSAGE": "UF_CRM_NEWTECH_V1_STRING",
                "HELP_MESSAGE": "UF_CRM_NEWTECH_V1_STRING"
                }
            ],
            "total": 4,
            "time": {
                "start": 1717754823.56747,
                "finish": 1717754823.938955,
                "duration": 0.37148499488830566,
                "processing": 0.007915973663330078,
                "date_start": "2024-06-07T12:07:03+02:00",
                "date_finish": "2024-06-07T12:07:03+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	Array of objects with information from the selected custom fields. Each element contains the selected fields describing the custom field of the requisite
total `integer`	Total number of records found
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 40x, 50x

{
            "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 Errors

Error Text	Description
`Access denied`	Insufficient access permissions to retrieve the list of custom fields of the requisite

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

Get a Custom Field by ID

Delete a Custom Requisite Field

Get a list of custom fields of the requisite by filter crm.requisite.userfield.list

Method ParametersMethod Parameters

Description of custom field of requisiteDescription of custom field of requisite

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning