Get a List of Directory Items by Filter crm.status.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: any user with permission to read at least one CRM object
The method crm.status.list returns a list of directory items based on the filter.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
order |
Object format:
The list of fields for sorting can be found using the method crm.status.fields |
|
filter |
Object format:
For the The list of fields for filtering can be found using the method crm.status.fields |
Code Examples
How to Use Examples in Documentation
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>
Example
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 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}")
Example as_list
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 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}")
Example as_list_fast
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 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(
'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 and ctx are already created — see the Go SDK section
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("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.EntityID)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP status: 200
{
"result": [
{
"ID": "101",
"ENTITY_ID": "DEAL_STAGE",
"STATUS_ID": "NEW",
"NAME": "New",
"NAME_INIT": "New",
"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": "Document preparation",
"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": "Prepayment invoice",
"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": "In progress",
"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": "Final invoice",
"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": "Deal successful",
"NAME_INIT": "Deal successful",
"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": "Deal failed",
"NAME_INIT": "Deal failed",
"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": "Failure reason analysis",
"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
}
}
Returned Data
|
Name |
Description |
|
result |
An array of objects with information about directory items (detailed description) |
|
total |
The total number of found items |
|
time |
Information about the request execution time |
resultObject Fields
|
Name |
Description |
|
ID |
Directory item ID |
|
ENTITY_ID |
ID of the object that the directory is linked to |
|
STATUS_ID |
Status value code |
|
NAME |
Name |
|
NAME_INIT |
Initial name |
|
SORT |
Sorting |
|
SYSTEM |
System value flag:
|
|
CATEGORY_ID |
ID of the pipeline that the status is linked to. Returns |
|
COLOR |
Status color for Kanban in HEX format |
|
SEMANTICS |
Stage group:
|
|
EXTRA |
Additional status fields (detailed description) |
EXTRA Object
|
Name |
Description |
|
SEMANTICS |
Stage semantics for the interface. Possible values: |
|
COLOR |
Stage color for the interface in HEX format |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Filter by ENTITY_ID must be a string"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Meaning |
|
|
Empty value |
|
No permission to perform the operation |
|
|
Empty value |
|
An array was passed in the |
|
|
Empty value |
|
An array was passed in the |
|
|
Empty value |
|
An array was passed in the |
|
|
Empty value |
|
An array was passed in the |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Get Description of CRM Status Fields crm.status.fields
- Get a Directory Item by ID crm.status.get
- Create CRM Status Element crm.status.add
- Update CRM Status Element crm.status.update
- Delete CRM Status Element crm.status.delete
- How to Filter Items by Stage Name
- How to Retrieve a List of Stages with Semantics for CRM Entities
- How to Create a New Sales Funnel with Stages in a Smart Process