Get CRM Status Entity Types

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who 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>
        
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();
        }
        

Example

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        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}")
        
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>';
        

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
type

Description

result
array

Array of objects describing the types of directories (detailed field description)

time
time

Information about the request execution time

Fields of the Result Object

Name
type

Description

ID
string

Object identifier, use the value in the ENTITY_ID field of the crm.status.* methods

NAME
string

Name

ENTITY_TYPE_ID
integer

CRM object type to which the status belongs

SEMANTIC_INFO
object

Information about the semantics of status stages

PREFIX
string

Prefix for the stage code in the funnel

FIELD_ATTRIBUTE_SCOPE
string

Field application area, funnel

IS_ENABLED
boolean

Activity

CATEGORY_ID
integer

Funnel identifier

PARENT_ID
string

ID of the parent element

CATEGORY_NAME
string

Funnel name

CATEGORY_SORT
integer

Funnel sorting

IS_DEFAULT_CATEGORY
boolean

Default funnel

Error Handling

The method does not return errors.

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site 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