Get the list of Kanban stages or "My Planner" task.stages.get

Scope: task

Who can execute the method:

any user for "My Planner" stages

any user with access to the group for Kanban stages

The method retrieves the stages of the Kanban or "My Planner".

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 stages of the group's Kanban. An access error will be returned if the permission level is insufficient.
0 — the method will retrieve the stages of "My Planner" 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'task.stages.get',
        		{
        			entityId: entityId,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('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']);
        }

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 Planner stages, with stage identifiers as keys.
ID `integer`	Identifier of the stage.
TITLE `string`	Name.
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 items 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 `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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Value
`ACCESS_DENIED`	You cannot view stages in this group.

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Update a Kanban Stage or "My Planner"

Check the Possibility of Moving a Task

Get the list of Kanban stages or "My Planner" task.stages.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning