Получить описание полей справочника crm.status.fields

Scope: crm

Кто может выполнять метод: любой пользователь

Метод crm.status.fields возвращает описание полей справочников CRM.

Параметры метода

Без параметров.

Примеры кода

Как использовать примеры в документации

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{}' \
             https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.status.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.status.fields
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.status.fields",
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.status.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching CRM status fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.status.fields",
            {},
            function(result) {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.status.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "ID": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "ID"
                },
                "ENTITY_ID": {
                    "type": "string",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "ID элемента сущности"
                },
                "STATUS_ID": {
                    "type": "string",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Статус"
                },
                "SORT": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Сортировка"
                },
                "NAME": {
                    "type": "string",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Название"
                },
                "NAME_INIT": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Название по умолчанию"
                },
                "SYSTEM": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Системный"
                },
                "CATEGORY_ID": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "CATEGORY_ID"
                },
                "COLOR": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "COLOR"
                },
                "SEMANTICS": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "SEMANTICS"
                },
                "EXTRA": {
                    "type": "crm_status_extra",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Дополнительные поля"
                }
            },
            "time": {
                "start": 1752132864.335154,
                "finish": 1752132864.366912,
                "duration": 0.03175783157348633,
                "processing": 0.002053976058959961,
                "date_start": "2025-07-10T10:34:24+03:00",
                "date_finish": "2025-07-10T10:34:24+03:00",
                "operating_reset_at": 1752133464,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Объект с описанием полей (подробное описание)

time
time

Информация о времени выполнения запроса

Поля объекта result

Название
тип

Описание

ID
integer

Идентификатор статуса, используется в методах crm.status.*

ENTITY_ID
string

Идентификатор типа статуса

STATUS_ID
string

Код значения статуса, используется в методах объектов CRM

SORT
integer

Порядок сортировки

NAME
string

Название

NAME_INIT
string

Название по умолчанию

SYSTEM
char

Флаг, указывающий, является ли статус системным

CATEGORY_ID
integer

Идентификатор воронки, к которой относится статус-стадия

COLOR
string

Цвет статуса-стадии для канбана

SEMANTICS
char

Группа стадий:

  • "S" — успех,
  • "F" — провал,
  • "" — в работе

EXTRA
object

Дополнительные поля

Обработка ошибок

Метод не возвращает ошибок.

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Удалить элемент справочника
Следующая
Обзор методов