crm.status.list
Получить список элементов справочника по фильтру
Описание
Метод crm.status.list возвращает список элементов справочника по фильтру.
Параметры
order
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
field_n— название поля, по которому будет произведена сортировка элементов справочникаvalue_n— значение типаstring, равное:
-ASC— сортировка по возрастанию
-DESC— сортировка по убыванию
Список полей для сортировки можно узнать методом crm.status.fields
filter
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
field_n— название поля, по которому будет отфильтрована выборка элементовvalue_n— значение фильтра
Для полей ENTITY_ID, STATUS_ID, SORT, SEMANTICS передавайте строку. Массивы в этих полях не поддерживаются.
Список полей для фильтрации можно узнать методом crm.status.fields
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"SORT":"ASC"},"filter":{"ENTITY_ID":"DEAL_STAGE"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.status.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"SORT":"ASC"},"filter":{"ENTITY_ID":"DEAL_STAGE"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.status.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
// Shape of each status object returned in result[]
type CrmStatusListItem = {
ID: string
ENTITY_ID: string
STATUS_ID: string
NAME: string
NAME_INIT: string
SORT: string
SYSTEM: string
CATEGORY_ID: string | null
COLOR: string
SEMANTICS: string | null
EXTRA: {
SEMANTICS: string
COLOR: string
}
}
try {
const response = await $b24.actions.v2.call.make<CrmStatusListItem[]>({
method: 'crm.status.list',
params: {
order: {
SORT: 'ASC',
},
filter: {
ENTITY_ID: '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('Statuses on this page:', 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 listStatuses() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.status.list',
params: {
order: {
SORT: 'ASC',
},
filter: {
ENTITY_ID: '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('Statuses on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listStatuses)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.status.list(
order={
"SORT": "ASC",
},
filter={
"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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.status.list(
order={
"SORT": "ASC",
},
filter={
"ENTITY_ID": "DEAL_STAGE",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.status.list(
order={
"SORT": "ASC",
},
filter={
"ENTITY_ID": "DEAL_STAGE",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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}")
try {
$response = $b24Service
->core
->call(
'crm.status.list',
[
'order' => ['SORT' => 'ASC'],
'filter' => ['ENTITY_ID' => '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 list: ' . $e->getMessage();
}
BX24.callMethod(
"crm.status.list",
{
order: { SORT: "ASC" },
filter: { ENTITY_ID: "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.list',
[
'order' => [ 'SORT' => 'ASC' ],
'filter' => [ 'ENTITY_ID' => 'DEAL_STAGE' ]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.status.list", b24.Params{
"order": b24.Params{
"SORT": "ASC",
},
"filter": b24.Params{
"ENTITY_ID": "DEAL_STAGE",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.status.list: %w", err)
}
var items []struct {
ID string `json:"ID"`
EntityID string `json:"ENTITY_ID"`
StatusID string `json:"STATUS_ID"`
Name string `json:"NAME"`
NameInit string `json:"NAME_INIT"`
Sort string `json:"SORT"`
System string `json:"SYSTEM"`
CategoryID *string `json:"CATEGORY_ID"`
Color string `json:"COLOR"`
Semantics *string `json:"SEMANTICS"`
Extra struct {
Semantics string `json:"SEMANTICS"`
Color string `json:"COLOR"`
} `json:"EXTRA"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.EntityID)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"ID": "101",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "NEW",
"NAME": "Новая",
"NAME_INIT": "Новая",
"SORT": "10",
"SYSTEM": "Y",
"CATEGORY_ID": null,
"COLOR": "#39A8EF",
"SEMANTICS": null,
"EXTRA": {
"SEMANTICS": "process",
"COLOR": "#39A8EF"
}
},
{
"ID": "103",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "PREPARATION",
"NAME": "Подготовка документов",
"NAME_INIT": "",
"SORT": "20",
"SYSTEM": "N",
"CATEGORY_ID": null,
"COLOR": "#2FC6F6",
"SEMANTICS": null,
"EXTRA": {
"SEMANTICS": "process",
"COLOR": "#2FC6F6"
}
},
{
"ID": "105",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "PREPAYMENT_INVOICE",
"NAME": "Cчет на предоплату",
"NAME_INIT": "",
"SORT": "30",
"SYSTEM": "N",
"CATEGORY_ID": null,
"COLOR": "#55D0E0",
"SEMANTICS": null,
"EXTRA": {
"SEMANTICS": "process",
"COLOR": "#55D0E0"
}
},
{
"ID": "107",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "EXECUTING",
"NAME": "В работе",
"NAME_INIT": "",
"SORT": "40",
"SYSTEM": "N",
"CATEGORY_ID": null,
"COLOR": "#47E4C2",
"SEMANTICS": null,
"EXTRA": {
"SEMANTICS": "process",
"COLOR": "#47E4C2"
}
},
{
"ID": "109",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "FINAL_INVOICE",
"NAME": "Финальный счет",
"NAME_INIT": "",
"SORT": "50",
"SYSTEM": "N",
"CATEGORY_ID": null,
"COLOR": "#FFA900",
"SEMANTICS": null,
"EXTRA": {
"SEMANTICS": "process",
"COLOR": "#FFA900"
}
},
{
"ID": "111",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "WON",
"NAME": "Сделка успешна",
"NAME_INIT": "Сделка успешна",
"SORT": "60",
"SYSTEM": "Y",
"CATEGORY_ID": null,
"COLOR": "#7BD500",
"SEMANTICS": "S",
"EXTRA": {
"SEMANTICS": "success",
"COLOR": "#7BD500"
}
},
{
"ID": "113",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "LOSE",
"NAME": "Сделка провалена",
"NAME_INIT": "Сделка провалена",
"SORT": "70",
"SYSTEM": "Y",
"CATEGORY_ID": null,
"COLOR": "#FF5752",
"SEMANTICS": "F",
"EXTRA": {
"SEMANTICS": "failure",
"COLOR": "#FF5752"
}
},
{
"ID": "115",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "APOLOGY",
"NAME": "Анализ причины провала",
"NAME_INIT": "",
"SORT": "80",
"SYSTEM": "N",
"CATEGORY_ID": null,
"COLOR": "#FF5752",
"SEMANTICS": "F",
"EXTRA": {
"SEMANTICS": "apology",
"COLOR": "#FF5752"
}
}
],
"total": 8,
"time": {
"start": 1752146147.312812,
"finish": 1752146147.354549,
"duration": 0.04173684120178223,
"processing": 0.00507807731628418,
"date_start": "2025-07-10T14:15:47+03:00",
"date_finish": "2025-07-10T14:15:47+03:00",
"operating_reset_at": 1752146747,
"operating": 0
}
}
Возвращаемые данные
result
array
Массив объектов с информацией об элементах справочника (подробное описание)
total
integer
Общее количество найденных элементов
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Filter by ENTITY_ID must be a string"
}
| Код | Описание | Значение |
|---|---|---|
400 |
Пустое значение | Access denied. |
400 |
Пустое значение | Filter by ENTITY_ID must be a string |
400 |
Пустое значение | Filter by STATUS_ID must be a string |
400 |
Пустое значение | Filter by SORT must be a string |
400 |
Пустое значение | Filter by SEMANTICS must be a string |

