Get User Field Settings userfieldconfig.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","id":7095,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userfieldconfig.get
        

// 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 the payload returned in result (match the "response handling" section of the page)
        type UserfieldconfigGetResult = {
          field: {
            id: string
            entityId: string
            fieldName: string
            userTypeId: string
            xmlId: string | null
            sort: string
            multiple: string
            mandatory: string
            showFilter: string
            showInList: string
            editInList: string
            isSearchable: string
            settings: Record<string, unknown>
            languageId: Record<string, string>
            editFormLabel: Record<string, string | null>
            listColumnLabel: Record<string, string | null>
            listFilterLabel: Record<string, string | null>
            errorMessage: Record<string, string | null>
            helpMessage: Record<string, string | null>
            enum?: Array<{
              id: string
              userFieldId: string
              value: string
              def: string
              sort: string
              xmlId: string
            }>
          } | null
        }
        
        try {
          const response = await $b24.actions.v2.call.make<UserfieldconfigGetResult>({
            method: 'userfieldconfig.get',
            params: {
              moduleId: 'crm',
              id: 7095,
            },
            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(result.field?.id, result.field?.fieldName, result.field?.userTypeId)
          }
        } 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 getUserfieldConfig() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'userfieldconfig.get',
                params: {
                  moduleId: 'crm',
                  id: 7095,
                },
                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(result.field?.id, result.field?.fieldName, result.field?.userTypeId)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getUserfieldConfig)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.userfieldconfig.get(
                module_id="crm",
                bitrix_id=7095,
            ).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.get',
                    [
                        'moduleId' => 'crm',
                        'id' => 7095,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

BX24.callMethod(
            'userfieldconfig.get',
            {
                moduleId: 'crm',
                id: 7095,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        

require_once('crest.php');
        
        $result = CRest::call(
            'userfieldconfig.get',
            [
                'moduleId' => 'crm',
                'id' => 7095,
            ]
        );
        
        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.get", b24.Params{
        	"moduleId": "crm",
        	"id":       7095,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("userfieldconfig.get: %w", err)
        }
        
        // The method wraps the response in an object with the "field" key.
        raw, ok := b24.Unwrap(res.Result, "field")
        if !ok {
        	return fmt.Errorf("no field key in the response")
        }
        
        var item 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, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.EntityID)