Get the List of Kanban Stages or "My Plan" task.stages.get

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: task

Who can execute the method:

  • any user for "My Plan" stages
  • any user with group access for Kanban stages

The method task.stages.get retrieves Kanban stages or "My Plan" stages.

Method Parameters

Required parameters are marked with *

Name
type

Description

entityId*
integer

Identifier of the object.

Possible values:

  • ID of the group — the method will retrieve the Kanban stages of the group. An access error will be returned if the permission level is insufficient.
  • 0 — the method will retrieve the stages of "My Plan" for the current user.

isAdmin
boolean

If set to true, permission checks will not occur, provided that the requester is an administrator of the account.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        "entityId": 0
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/task.stages.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: YOUR_ACCESS_TOKEN" \
        -d '{
        "entityId": 0
        }' \
        https://your-domain.bitrix24.com/rest/task.stages.get
        
// 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 stage in the result map
        type StageInfo = {
          ID: string
          TITLE: string
          SORT: string
          COLOR: string
          SYSTEM_TYPE: string | null
          ENTITY_ID: string
          ENTITY_TYPE: string
          ADDITIONAL_FILTER: unknown[]
          TO_UPDATE: unknown[]
          TO_UPDATE_ACCESS: null
        }
        
        // result is a map of stage ID → StageInfo
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type StagesGetResult = Record<string, StageInfo>
        
        try {
          const response = await $b24.actions.v2.call.make<StagesGetResult>({
            method: 'task.stages.get',
            params: {
              entityId: 0,
            },
            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('Stages:', Object.values(result).map(s => `${s.ID}: ${s.TITLE}`))
          }
        } 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 getTaskStages() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'task.stages.get',
                params: {
                  entityId: 0,
                },
                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('Stages:', Object.values(result).map(s => `${s.ID}: ${s.TITLE}`))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getTaskStages)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.task.stages.get(
                entity_id=0,
            ).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(
                    'task.stages.get',
                    [
                        'entityId' => $entityId,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting task stages: ' . $e->getMessage();
        }
        
const entityId = 0;
        BX24.callMethod(
            'task.stages.get',
            {
                entityId: entityId,
            },
            function(res)
            {
                console.log(res);
            }
        );
        
require_once('crest.php'); // connecting CRest PHP SDK
        
        $entityId = 0;
        
        // executing the request to the REST API
        $result = CRest::call(
            'task.stages.get',
            [
                'entityId' => $entityId
            ]
        );
        
        // Processing the response from Bitrix24
        if ($result['error']) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "task.stages.get", b24.Params{
        	"entityId": 0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("task.stages.get: %w", err)
        }
        
        keys, ok := b24.Keys(res.Result)
        if !ok {
        	return fmt.Errorf("expected an object in the response")
        }
        fmt.Println("fields in response:", len(keys))
        

Response Handling

HTTP Status: 200

{
            "result": {
                "5": {
                 "ID": "5",
                 "TITLE": "Not Planned",
                 "SORT": "100",
                 "COLOR": "00C4FB",
                 "SYSTEM_TYPE": "NEW",
                 "ENTITY_ID": "1",
                 "ENTITY_TYPE": "U",
                 "ADDITIONAL_FILTER": [],
                 "TO_UPDATE": [],
                 "TO_UPDATE_ACCESS": null
                },
                "6": {
                 "ID": "6",
                 "TITLE": "I Will Do It This Week",
                 "SORT": "200",
                 "COLOR": "47D1E2",
                 "SYSTEM_TYPE": null,
                 "ENTITY_ID": "1",
                 "ENTITY_TYPE": "U",
                 "ADDITIONAL_FILTER": [],
                 "TO_UPDATE": [],
                 "TO_UPDATE_ACCESS": null
                }
            }
        }
        

Returned Data

Field
type

Description

result
object

An object containing data about the Kanban / My Plan stages, with stage IDs as keys.

ID
integer

Identifier of the stage.

TITLE
string

Title.

SORT
integer

Sorting.

COLOR
string

Color in RGB format.

SYSTEM_TYPE
string

System type. Possible values: NEW, PROGRESS, WORK, REVIEW, FINISH.

ENTITY_ID
integer

Identifier of the object, i.e., group or user.

ENTITY_TYPE
string

Type of the object. U for user, G for group.

ADDITIONAL_FILTER
array

Additional filters.

System parameter. Always has the value of an empty array.

TO_UPDATE
array

Array of elements to update.

System parameter. Always has the value of an empty array.

TO_UPDATE_ACCESS
null

Functions applied to the task when moving to this stage.

System parameter. Always has the value of null.

Error Handling

HTTP Status: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "You cannot view stages in this group."
        }
        

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

Code

Description

ACCESS_DENIED

You cannot view stages in this group.

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