Get Stage History with crm.stagehistory.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: crm

Who can execute the method: any user

The method crm.stagehistory.list returns records of stage movement history for the following elements:

Method Parameters

Name
type

Description

entityTypeId
integer

Identifier of the object type. Can take the following values:

  • 1 — lead,
  • 2 — deal,
  • 5 — invoice (old),
  • 31 - invoice (new),
  • numeric identifier of a custom type, for example 130

order
object

Sorting list, where the key is the field and the value is ASC or DESC

filter
object

Filtering list. The filter supports the use of exact values, arrays of values, and modifiers:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string
  • =% — LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values starting with "mol"
    • "%mol" — searches for values ending with "mol"
    • "%mol%" — searches for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • !% — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides
  • !=% — NOT LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values not starting with "mol"
    • "%mol" — searches for values not ending with "mol"
    • "%mol%" — searches for values where the substring "mol" is not present in any position
  • !%= — NOT LIKE (similar to !=%)
  • = — equals, exact match (used by default)
  • != — not equal
  • ! — not equal

select
object

List of fields to retrieve

start
integer

Offset for pagination. The pagination logic is standard for list methods

Code Examples

How to Use Examples in Documentation

Get stage movement history for the deal with ID=1

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"order":{"ID":"ASC"},"filter":{"OWNER_ID":1},"select":["ID","STAGE_ID","CREATED_TIME"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.stagehistory.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"order":{"ID":"ASC"},"filter":{"OWNER_ID":1},"select":["ID","STAGE_ID","CREATED_TIME"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.stagehistory.list
        
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        const parameters = {
            entityTypeId: 2,
            order: { "ID": "ASC" },
            filter: { "OWNER_ID": 1 },
            select: [ "ID", "STAGE_ID", "CREATED_TIME" ]
        };
        
        try {
          const response = await $b24.callListMethod(
            'crm.stagehistory.list',
            parameters,
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('crm.stagehistory.list', parameters, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.stagehistory.list', parameters, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.stagehistory.list(
                entity_type_id=2,
                order={
                    "ID": "ASC",
                },
                filter={
                    "OWNER_ID": 1,
                },
                select=[
                    "ID",
                    "STAGE_ID",
                    "CREATED_TIME",
                ],
            ).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.stagehistory.list(
                entity_type_id=2,
                order={
                    "ID": "ASC",
                },
                filter={
                    "OWNER_ID": 1,
                },
                select=[
                    "ID",
                    "STAGE_ID",
                    "CREATED_TIME",
                ],
            ).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.stagehistory.list(
                entity_type_id=2,
                order={
                    "ID": "ASC",
                },
                filter={
                    "OWNER_ID": 1,
                },
                select=[
                    "ID",
                    "STAGE_ID",
                    "CREATED_TIME",
                ],
            ).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.stagehistory.list',
                    [
                        'entityTypeId' => 2,
                        'order' => ['ID' => 'ASC'],
                        'filter' => ['OWNER_ID' => 1],
                        'select' => ['ID', 'STAGE_ID', 'CREATED_TIME'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error listing stage history: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.stagehistory.list",
            {
                entityTypeId: 2,
                order: { "ID": "ASC" },
                filter: { "OWNER_ID": 1 },
                select: [ "ID", "STAGE_ID", "CREATED_TIME" ]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());
                    if(result.more())
                        result.next();
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.stagehistory.list',
            [
                'entityTypeId' => 2,
                'order' => ['ID' => 'ASC'],
                'filter' => ['OWNER_ID' => 1],
                'select' => ['ID', 'STAGE_ID', 'CREATED_TIME']
            ]
        );
        
        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.stagehistory.list", b24.Params{
        	"entityTypeId": 2,
        	"order": b24.Params{
        		"ID": "ASC",
        	},
        	"filter": b24.Params{
        		"OWNER_ID": 1,
        	},
        	"select": []string{"ID", "STAGE_ID", "CREATED_TIME"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.stagehistory.list: %w", err)
        }
        
        // The method wraps the response in an object with the "items" key.
        raw, ok := b24.Unwrap(res.Result, "items")
        if !ok {
        	return fmt.Errorf("no items key in the response")
        }
        
        var items []struct {
        	ID              b24.ID `json:"ID"`
        	TypeID          b24.ID `json:"TYPE_ID"`
        	OwnerID         b24.ID `json:"OWNER_ID"`
        	CreatedTime     string `json:"CREATED_TIME"`
        	CategoryID      b24.ID `json:"CATEGORY_ID"`
        	StageSemanticID string `json:"STAGE_SEMANTIC_ID"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }

Get stage movement history for the SPA with entityTypeId=130 and element OWNER_ID=29

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":130,"order":{"ID":"ASC"},"filter":{"OWNER_ID":29},"select":["ID","STAGE_ID","CREATED_TIME"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.stagehistory.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":130,"order":{"ID":"ASC"},"filter":{"OWNER_ID":29},"select":["ID","STAGE_ID","CREATED_TIME"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.stagehistory.list
        
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        const parameters = {
            entityTypeId: 130,
            order: { "ID": "ASC" },
            filter: { "OWNER_ID": 29 },
            select: [ "ID", "STAGE_ID", "CREATED_TIME" ]
        };
        
        try {
          const response = await $b24.callListMethod(
            'crm.stagehistory.list',
            parameters,
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('crm.stagehistory.list', parameters, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.stagehistory.list', parameters, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.stagehistory.list(
                entity_type_id=130,
                select=[
                    "ID",
                    "STAGE_ID",
                    "CREATED_TIME",
                ],
                filter={
                    "OWNER_ID": 29,
                },
                order={
                    "ID": "ASC",
                },
            ).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.stagehistory.list(
                entity_type_id=130,
                select=[
                    "ID",
                    "STAGE_ID",
                    "CREATED_TIME",
                ],
                filter={
                    "OWNER_ID": 29,
                },
                order={
                    "ID": "ASC",
                },
            ).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.stagehistory.list(
                entity_type_id=130,
                select=[
                    "ID",
                    "STAGE_ID",
                    "CREATED_TIME",
                ],
                filter={
                    "OWNER_ID": 29,
                },
                order={
                    "ID": "ASC",
                },
            ).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.stagehistory.list',
                    [
                        'entityTypeId' => 130,
                        'order' => ['ID' => 'ASC'],
                        'filter' => ['OWNER_ID' => 29],
                        'select' => ['ID', 'STAGE_ID', 'CREATED_TIME'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error listing stage history: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.stagehistory.list",
            {
                entityTypeId: 130,
                order: { "ID": "ASC" },
                filter: { "OWNER_ID": 29 },
                select: [ "ID", "STAGE_ID", "CREATED_TIME" ]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());
                    if(result.more())
                        result.next();
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.stagehistory.list',
            [
                'entityTypeId' => 130,
                'order' => ['ID' => 'ASC'],
                'filter' => ['OWNER_ID' => 29],
                'select' => ['ID', 'STAGE_ID', 'CREATED_TIME']
            ]
        );
        
        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.stagehistory.list", b24.Params{
        	"entityTypeId": 130,
        	"order": b24.Params{
        		"ID": "ASC",
        	},
        	"filter": b24.Params{
        		"OWNER_ID": 29,
        	},
        	"select": []string{"ID", "STAGE_ID", "CREATED_TIME"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.stagehistory.list: %w", err)
        }
        
        // The method wraps the response in an object with the "items" key.
        raw, ok := b24.Unwrap(res.Result, "items")
        if !ok {
        	return fmt.Errorf("no items key in the response")
        }
        
        var items []struct {
        	ID              b24.ID `json:"ID"`
        	TypeID          b24.ID `json:"TYPE_ID"`
        	OwnerID         b24.ID `json:"OWNER_ID"`
        	CreatedTime     string `json:"CREATED_TIME"`
        	CategoryID      b24.ID `json:"CATEGORY_ID"`
        	StageSemanticID string `json:"STAGE_SEMANTIC_ID"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }

Response Handling

HTTP Status: 200

{
            "result": {
                "items": [
                {
                    "ID": 35,
                    "TYPE_ID": 1,
                    "OWNER_ID": 21,
                    "CREATED_TIME": "2024-04-25T14:59:11+00:00",
                    "CATEGORY_ID": 0,
                    "STAGE_SEMANTIC_ID": "P",
                    "STAGE_ID": "NEW"
                }
                ]
            },
            "total": 1,
            "time": {
                "start": 1724106224.858572,
                "finish": 1724106225.344968,
                "duration": 0.48639607429504395,
                "processing": 0.11864185333251953,
                "date_start": "2024-08-15T22:15:44+00:00",
                "date_finish": "2024-08-15T22:15:45+00:00",
                "operating": 0.11855506896972656
            }
        }

Returned Data

Name
type

Description

result
array

Root element of the response, contains an array of items. Each object is an array with keys

time
time

Information about the request execution time

Object items

Name
type

Description

ID
integer

Record identifier

TYPE_ID
integer

Record type. Can take the following values:

  • 1 — creation of an element,
  • 2 — transfer to an intermediate stage,
  • 3 — transfer to the final stage,
  • 5 — change of funnel

OWNER_ID
integer

Identifier of the object in which the stage changed

CREATED_TIME
datetime

Identifier of the created element, equal to the time of transferring the element to the stage

Additionally, there are fields specific to different object types:

Name
type

Description

STATUS_SEMANTIC_ID
string

Stage semantics:

  • P — intermediate stage,
  • S — successful stage,
  • F — failed stage

STATUS_ID
crm_status

Identifier of the stage

Name
type

Description

CATEGORY_ID
integer

Identifier of the funnel

STAGE_SEMANTIC_ID
string

Stage semantics:

  • P — intermediate stage,
  • S — successful stage,
  • F — failed stage

STAGE_ID
crm_status

Identifier of the stage

Error Handling

HTTP Status: 401, 400

{
            "error": 0,
            "error_description": "SHIPMENT_DOCUMENT entity is not supported"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

403

allowed_only_intranet_user

Action is allowed only for intranet users

User is not an intranet user

400

ENTITY_TYPE_NOT_SUPPORTED

Entity type TYPE is not supported

Occurs when an invalid entityTypeId is passed

400

INVALID_ARG_VALUE

Invalid filter: field 'field' is not allowed in filter

The field field passed in filter is not available for filtering

400

INVALID_ARG_VALUE

Invalid filter: field 'field' has invalid value

The value passed for field field in filter is incorrect

400

INVALID_ARG_VALUE

Invalid order: field 'field' is not allowed in order

The field field passed in order is not available for sorting

400

INVALID_ARG_VALUE

Invalid order: allowed sort directions are ASC, DESC. But got 'orderValue' for field 'field'

The value orderValue passed for field field in the order parameter is incorrect

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

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

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Previous
Get VAT Rate Fields
Next
Overview of Sections