Получить элементы справочника по типу crm.status.entity.items
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь
Метод crm.status.entity.items возвращает все элементы справочника по идентификатору ENTITY_ID с сортировкой по полю SORT.
Метод аналогичен crm.status.list, за исключением того, что в последнем можно определить правила сортировки.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityId* |
Тип справочника, например |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityId":"DEAL_STAGE"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.status.entity.items
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityId":"DEAL_STAGE","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.status.entity.items
// 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 item returned in result[]
type CrmStatusEntityItem = {
NAME: string
SORT: number
STATUS_ID: string
}
try {
const response = await $b24.actions.v2.call.make<CrmStatusEntityItem[]>({
method: 'crm.status.entity.items',
params: {
entityId: 'DEAL_STAGE',
},
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('Entity items:', 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 getStatusEntityItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.status.entity.items',
params: {
entityId: 'DEAL_STAGE',
},
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('Entity items:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getStatusEntityItems)
</script>
try {
$response = $b24Service
->core
->call(
'crm.status.entity.items',
[
'entityId' => 'DEAL_STAGE'
]
);
$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 status entity items: ' . $e->getMessage();
}
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.status.entity.items(
entity_id="DEAL_STAGE",
).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}")
BX24.callMethod(
"crm.status.entity.items",
{
entityId: "DEAL_STAGE"
},
function(result) {
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.status.entity.items',
[
'entityId' => 'DEAL_STAGE'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"NAME": "Новая",
"SORT": 10,
"STATUS_ID": "NEW"
},
{
"NAME": "Подготовка документов",
"SORT": 20,
"STATUS_ID": "PREPARATION"
},
{
"NAME": "Cчет на предоплату",
"SORT": 30,
"STATUS_ID": "PREPAYMENT_INVOICE"
},
{
"NAME": "В работе",
"SORT": 40,
"STATUS_ID": "EXECUTING"
},
{
"NAME": "Финальный счет",
"SORT": 50,
"STATUS_ID": "FINAL_INVOICE"
},
{
"NAME": "Сделка успешна",
"SORT": 60,
"STATUS_ID": "WON"
},
{
"NAME": "Сделка провалена",
"SORT": 70,
"STATUS_ID": "LOSE"
},
{
"NAME": "Анализ причины провала",
"SORT": 80,
"STATUS_ID": "APOLOGY"
}
],
"time": {
"start": 1752144806.703358,
"finish": 1752144806.76889,
"duration": 0.06553196907043457,
"processing": 0.010729789733886719,
"date_start": "2025-07-10T13:53:26+03:00",
"date_finish": "2025-07-10T13:53:26+03:00",
"operating_reset_at": 1752145406,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив элементов справочника |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "The parameter entityId is not defined or invalid.",
"error_description": "Не указан или некорректен идентификатор справочника."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
Нет прав на выполнение операции |
|
|
|
Не указан или некорректен идентификатор справочника |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |