Get CRM Status Entity Types crm.status.entity.types
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
The method crm.status.entity.types returns a list of all supported directory types and ENTITY_ID objects.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
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.entity.types
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.entity.types
// 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 entity type returned in result[]
type CrmStatusEntityType = {
ID: string
NAME: string
ENTITY_TYPE_ID?: number
SEMANTIC_INFO?: {
START_FIELD: string
FINAL_SUCCESS_FIELD: string
FINAL_UNSUCCESS_FIELD: string
FINAL_SORT: number
} | unknown[]
PREFIX?: string
FIELD_ATTRIBUTE_SCOPE?: string
IS_ENABLED?: boolean
CATEGORY_ID?: number | string
PARENT_ID?: string
CATEGORY_NAME?: string
CATEGORY_SORT?: number
IS_DEFAULT_CATEGORY?: boolean
}
try {
const response = await $b24.actions.v2.call.make<CrmStatusEntityType[]>({
method: 'crm.status.entity.types',
params: {},
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 types:', 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 getStatusEntityTypes() {
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.types',
params: {},
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 types:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getStatusEntityTypes)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.status.entity.types().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}")
try {
$response = $b24Service
->core
->call(
'crm.status.entity.types',
[]
);
$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 calling crm.status.entity.types: ' . $e->getMessage();
}
BX24.callMethod(
"crm.status.entity.types",
{},
function(result) {
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.status.entity.types',
[]
);
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.entity.types", nil)
if err != nil {
return fmt.Errorf("crm.status.entity.types: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
Response Handling
HTTP status: 200
{
"result": [
{
"ID": "STATUS",
"NAME": "Lead stages",
"SEMANTIC_INFO": {
"START_FIELD": "NEW",
"FINAL_SUCCESS_FIELD": "CONVERTED",
"FINAL_UNSUCCESS_FIELD": "JUNK",
"FINAL_SORT": 0
},
"ENTITY_TYPE_ID": 1
},
{
"ID": "SOURCE",
"NAME": "Sources"
},
{
"ID": "CONTACT_TYPE",
"NAME": "Contact type"
},
{
"ID": "COMPANY_TYPE",
"NAME": "Company type"
},
{
"ID": "EMPLOYEES",
"NAME": "Number of employees"
},
{
"ID": "INDUSTRY",
"NAME": "Industry"
},
{
"ID": "DEAL_TYPE",
"NAME": "Deal type"
},
{
"ID": "SMART_INVOICE_STAGE_5",
"NAME": "Invoice stages",
"SEMANTIC_INFO": [],
"PREFIX": "DT31_5",
"FIELD_ATTRIBUTE_SCOPE": "category_5",
"ENTITY_TYPE_ID": 31,
"IS_ENABLED": true,
"CATEGORY_ID": 5
},
{
"ID": "DEAL_STAGE_1",
"NAME": "Newest deal stages",
"PARENT_ID": "DEAL_STAGE",
"SEMANTIC_INFO": {
"START_FIELD": "C1:NEW",
"FINAL_SUCCESS_FIELD": "C1:WON",
"FINAL_UNSUCCESS_FIELD": "C1:LOSE",
"FINAL_SORT": 0
},
"PREFIX": "C1",
"FIELD_ATTRIBUTE_SCOPE": "category_1",
"ENTITY_TYPE_ID": 2,
"CATEGORY_ID": "1"
},
{
"ID": "DEAL_STAGE",
"NAME": "General deal stages",
"SEMANTIC_INFO": {
"START_FIELD": "NEW",
"FINAL_SUCCESS_FIELD": "WON",
"FINAL_UNSUCCESS_FIELD": "LOSE",
"FINAL_SORT": 0
},
"FIELD_ATTRIBUTE_SCOPE": "",
"ENTITY_TYPE_ID": 2,
"CATEGORY_ID": 0
},
{
"ID": "QUOTE_STATUS",
"NAME": "Quote stages",
"SEMANTIC_INFO": {
"START_FIELD": "DRAFT",
"FINAL_SUCCESS_FIELD": "APPROVED",
"FINAL_UNSUCCESS_FIELD": "DECLAINED",
"FINAL_SORT": 0
},
"ENTITY_TYPE_ID": 7
},
{
"ID": "HONORIFIC",
"NAME": "Inquiries"
},
{
"ID": "CALL_LIST",
"NAME": "Call statuses"
},
{
"ID": "SMART_DOCUMENT_STAGE_13",
"NAME": "Document stages",
"SEMANTIC_INFO": [],
"PREFIX": "DT36_13",
"FIELD_ATTRIBUTE_SCOPE": "category_13",
"ENTITY_TYPE_ID": 36,
"IS_ENABLED": true,
"CATEGORY_ID": 13
},
{
"ID": "DYNAMIC_177_STAGE_7",
"NAME": "Equipment Procurement (General)",
"SEMANTIC_INFO": [],
"PREFIX": "DT177_7",
"FIELD_ATTRIBUTE_SCOPE": "category_7",
"ENTITY_TYPE_ID": 177,
"IS_ENABLED": true,
"CATEGORY_ID": 7,
"CATEGORY_NAME": "General",
"CATEGORY_SORT": 500,
"IS_DEFAULT_CATEGORY": true
},
{
"ID": "DYNAMIC_177_STAGE_9",
"NAME": "Equipment Procurement (Second pipeline)",
"SEMANTIC_INFO": [],
"PREFIX": "DT177_9",
"FIELD_ATTRIBUTE_SCOPE": "category_9",
"ENTITY_TYPE_ID": 177,
"IS_ENABLED": true,
"CATEGORY_ID": 9,
"CATEGORY_NAME": "Second pipeline",
"CATEGORY_SORT": 500,
"IS_DEFAULT_CATEGORY": false
},
],
"time": {
"start": 1752142616.128453,
"finish": 1752142616.215683,
"duration": 0.08722996711730957,
"processing": 0.018637895584106445,
"date_start": "2025-07-10T13:16:56+03:00",
"date_finish": "2025-07-10T13:16:56+03:00",
"operating_reset_at": 1752143216,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array of objects describing the types of directories (detailed field description) |
|
time |
Information about the request execution time |
Fields of the Result Object
|
Name |
Description |
|
ID |
Object identifier, use the value in the |
|
NAME |
Name |
|
ENTITY_TYPE_ID |
CRM object type to which the status belongs |
|
SEMANTIC_INFO |
Information about the semantics of status stages |
|
PREFIX |
Prefix for the stage code in the funnel |
|
FIELD_ATTRIBUTE_SCOPE |
Field application area, funnel |
|
IS_ENABLED |
Activity |
|
CATEGORY_ID |
Funnel identifier |
|
PARENT_ID |
ID of the parent element |
|
CATEGORY_NAME |
Funnel name |
|
CATEGORY_SORT |
Funnel sorting |
|
IS_DEFAULT_CATEGORY |
Default funnel |
Error Handling
The method does not return errors.
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 |