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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each user field returned in result[]
        type UserUserfieldItem = {
          ID: string
          ENTITY_ID: string
          FIELD_NAME: string
          USER_TYPE_ID: string
          XML_ID: string | null
          SORT: string
          MULTIPLE: 'Y' | 'N'
          MANDATORY: 'Y' | 'N'
          SHOW_FILTER: string
          SHOW_IN_LIST: 'Y' | 'N'
          EDIT_IN_LIST: 'Y' | 'N'
          IS_SEARCHABLE: 'Y' | 'N'
          SETTINGS: Record<string, unknown>
          LIST?: Array<{ ID: string; SORT: string; VALUE: string; DEF: 'Y' | 'N'; XML_ID: string }>
        }
        
        // user.userfield.list returns a single page (max 50 records). For the whole result set
        // use a list helper: $b24.actions.v2.callList.make() returns every record as one
        // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
        // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
        // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
        
        try {
          const response = await $b24.actions.v2.call.make<UserUserfieldItem[]>({
            method: 'user.userfield.list',
            params: {
              order: { id: 'desc' },
              filter: { id: 13 },
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Loaded user fields:', result.length, result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listUserUserfields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // user.userfield.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
        
              const response = await $b24.actions.v2.call.make({
                method: 'user.userfield.list',
                params: {
                  order: { id: 'desc' },
                  filter: { id: 13 },
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Loaded user fields:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listUserUserfields)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        order = {
            "ID": "desc",
            "SORT": "asc",
        }
        filter = {
            "USER_TYPE_ID": "string",
            "SHOW_IN_LIST": "Y",
        }
        
        try:
            bitrix_response = client.user.userfield.list(
                order=order,
                filter=filter,
            ).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("Bitrix SDK error", error.message, sep="\n")
        except Exception as error:
            print("Unexpected error", error, sep="\n")
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        order = {
            "ID": "desc",
        }
        filter = {
            "SHOW_IN_LIST": "Y",
        }
        
        try:
            bitrix_response = client.user.userfield.list(
                order=order,
                filter=filter,
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        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("Bitrix SDK error", error.message, sep="\n")
        except Exception as error:
            print("Unexpected error", error, sep="\n")
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        order = {
            "ID": "desc",
        }
        filter = {
            "SHOW_IN_LIST": "Y",
        }
        
        try:
            bitrix_response = client.user.userfield.list(
                order=order,
                filter=filter,
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        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("Bitrix SDK error", error.message, sep="\n")
        except Exception as error:
            print("Unexpected error", error, sep="\n")
        

try {
            $response = $b24Service
                ->core
                ->call(
                    'user.userfield.list',
                    [
                        'order' => [
                            'id' => 'desc',
                        ],
                        'filter' => [
                            'id' => 13
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // The data processing logic you need
            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>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "user.userfield.list", b24.Params{
        	"order": b24.Params{
        		"id": "desc",
        	},
        	"filter": b24.Params{
        		"id": 13,
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("user.userfield.list: %w", err)
        }
        
        var items []struct {
        	ID         b24.ID `json:"ID"`
        	EntityID   string `json:"ENTITY_ID"`
        	FieldName  string `json:"FIELD_NAME"`
        	UserTypeID string `json:"USER_TYPE_ID"`
        	Sort       string `json:"SORT"`
        	Multiple   string `json:"MULTIPLE"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.EntityID)
        }
        
        // Total and Next are filled in by list methods; for a full
        // list traversal, use client.Core().Pages and Scan.
        if res.Total != nil {
        	fmt.Println("total:", *res.Total)
        }