Get a List of User Field Settings userfieldconfig.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","select":{"0":"*","language":"de"},"order":{"id":"DESC"},"filter":{"multiple":"Y"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userfieldconfig.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
        
        type UserFieldConfig = {
          id: string
          fieldName: string
          userTypeId: string
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type UserFieldConfigListResult = {
          fields: UserFieldConfig[]
        }
        
        // userfieldconfig.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<UserFieldConfigListResult>({
            method: 'userfieldconfig.list',
            params: {
              moduleId: 'crm',
              select: ['*'],
              order: {
                id: 'DESC',
              },
              filter: {
                multiple: 'Y',
              },
              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 ${result.fields.length} field config(s) on this page`)
            console.info(result.fields)
          }
        } 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 listUserFieldConfigs() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // userfieldconfig.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: 'userfieldconfig.list',
                params: {
                  moduleId: 'crm',
                  select: ['*'],
                  order: {
                    id: 'DESC',
                  },
                  filter: {
                    multiple: 'Y',
                  },
                  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 ${result.fields.length} field config(s) on this page`)
              console.info(result.fields)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listUserFieldConfigs)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.userfieldconfig.list(
                module_id="crm",
                select={
                    0: "*",
                    "language": "ru",
                },
                order={
                    "id": "DESC",
                },
                filter={
                    "multiple": "Y",
                },
                start=0,
            ).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}")
        

try {
            $response = $b24Service
                ->core
                ->call(
                    'userfieldconfig.list',
                    [
                        'moduleId' => 'crm',
                        'select' => [
                            0 => '*',
                            'language' => 'de',
                        ],
                        'order' => [
                            'id' => 'DESC',
                        ],
                        'filter' => [
                            'multiple' => 'Y',
                        ],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

BX24.callMethod(
            'userfieldconfig.list',
            {
                moduleId: 'crm',
                select: {
                    0: '*',
                    language: 'de',
                },
                order: {
                    id: 'DESC',
                },
                filter: {
                    multiple: 'Y',
                },
            },
            (result) => {
                if (result.error()) {
                    console.error(result.error());
                    return;
                }
        
                console.info(result.data());
        
                if (result.more()) {
                    result.next();
                }
            },
        );
        

require_once('crest.php');
        
        $result = CRest::call(
            'userfieldconfig.list',
            [
                'moduleId' => 'crm',
                'select' => [
                    0 => '*',
                    'language' => 'de',
                ],
                'order' => [
                    'id' => 'DESC',
                ],
                'filter' => [
                    'multiple' => 'Y',
                ],
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "userfieldconfig.list", b24.Params{
        	"moduleId": "crm",
        	"select": b24.Params{
        		"0":        "*",
        		"language": "ru",
        	},
        	"order": b24.Params{
        		"id": "DESC",
        	},
        	"filter": b24.Params{
        		"multiple": "Y",
        	},
        	"start": 0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("userfieldconfig.list: %w", err)
        }
        
        // The method wraps the response in an object with the "fields" key.
        raw, ok := b24.Unwrap(res.Result, "fields")
        if !ok {
        	return fmt.Errorf("no fields key in the response")
        }
        
        var items []struct {
        	ID         b24.ID `json:"id"`
        	EntityID   string `json:"entityId"`
        	FieldName  string `json:"fieldName"`
        	UserTypeID string `json:"userTypeId"`
        	Sort       string `json:"sort"`
        	Multiple   string `json:"multiple"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }