# userfieldconfig.get

URL: https://chugunov.pro/api-bitrix24/crm/universal/userfieldconfig/userfieldconfig-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить настройки пользовательского поля
Scope: `userfieldconfig, scope модуля из moduleId (например, crm)`
Кто может выполнять метод: пользователь с правом чтения объекта, которому принадлежит поле, в модуле moduleId

## Описание

Метод `userfieldconfig.get` возвращает настройки пользовательского поля по его идентификатору.

## Параметры

- `moduleId` `string` — обязательный. Идентификатор модуля, в котором находится поле
- `id` `integer` — обязательный. Идентификатор настроек пользовательского поля.
  Идентификатор можно получить методом [userfieldconfig.list](https://chugunov.pro/api-bitrix24/crm/universal/userfieldconfig/userfieldconfig-list/) или при создании поля методом [userfieldconfig.add](https://chugunov.pro/api-bitrix24/crm/universal/userfieldconfig/userfieldconfig-add/)

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "field": {
            "id": "7095",
            "entityId": "CRM_7",
            "fieldName": "UF_CRM_7_NEW_REST_LIST_2026",
            "userTypeId": "enumeration",
            "xmlId": null,
            "sort": "100",
            "multiple": "Y",
            "mandatory": "N",
            "showFilter": "N",
            "showInList": "Y",
            "editInList": "Y",
            "isSearchable": "N",
            "settings": {
                "DISPLAY": "LIST",
                "LIST_HEIGHT": 1,
                "CAPTION_NO_VALUE": "",
                "SHOW_NO_VALUE": "Y"
            },
            "languageId": {
                "en": "en",
                "ru": "ru"
            },
            "editFormLabel": {
                "en": "List of characteristics",
                "ru": "Список характеристик"
            },
            "listColumnLabel": {
                "en": null,
                "ru": null
            },
            "listFilterLabel": {
                "en": null,
                "ru": null
            },
            "errorMessage": {
                "en": null,
                "ru": null
            },
            "helpMessage": {
                "en": null,
                "ru": null
            },
            "enum": [
                {
                    "id": "3671",
                    "userFieldId": "7095",
                    "value": "Характеристика 1",
                    "def": "N",
                    "sort": "100",
                    "xmlId": "38a8c98a5de02f8ccdca2244e5065ecd"
                },
                {
                    "id": "3673",
                    "userFieldId": "7095",
                    "value": "Характеристика 2",
                    "def": "Y",
                    "sort": "200",
                    "xmlId": "9520e17b39f3525b820b809914b52207"
                }
            ]
        }
    },
    "time": {
        "start": 1774355752,
        "finish": 1774355752.177393,
        "duration": 0.17739295959472656,
        "processing": 0,
        "date_start": "2026-03-24T15:35:52+03:00",
        "date_finish": "2026-03-24T15:35:52+03:00",
        "operating_reset_at": 1774356352,
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `object`. Корневой элемент ответа. Если поле не найдено, может вернуться `null`
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "",
    "error_description": "Вы не можете просматривать настройки пользовательских полей"
}
```

- — — Вы не можете просматривать настройки пользовательских полей. Недостаточно прав на просмотр поля. Эта же ошибка может возвращаться, если поле с переданным `id` уже удалено или недоступно в контексте `moduleId`
- — — The current method required more scopes. (crm). У приложения нет нужного scope для модуля из `moduleId`
- — — No settings for UserFieldAccess. Для переданного `moduleId` не настроен доступ к пользовательским полям

## Примеры запроса

### cURL (Webhook)

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

### cURL (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
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.js

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

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'userfieldconfig.get',
    [
        'moduleId' => 'crm',
        'id' => 7095,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
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)
}

// Метод заворачивает ответ в объект с ключом "field".
raw, ok := b24.Unwrap(res.Result, "field")
if !ok {
	return fmt.Errorf("в ответе нет ключа field")
}

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("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.EntityID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/crm/universal/userfieldconfig/userfieldconfig-get.html