Get the List of Kanban Stages or "My Plan" task.stages.get
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:
taskWho can execute the method:
- any user for "My Plan" stages
- any user with group access for Kanban stages
This method retrieves the Kanban stages or "My Plan".
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityId* |
Identifier of the object. Possible values:
|
|
isAdmin |
If set to |
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>
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 |
Description |
|
result |
An object containing data about the Kanban / My Plan stages, with stage IDs as keys. |
|
ID |
Identifier of the stage. |
|
TITLE |
Title. |
|
SORT |
Sorting. |
|
COLOR |
Color in RGB format. |
|
SYSTEM_TYPE |
System type. Possible values: |
|
ENTITY_ID |
Identifier of the object, i.e., group or user. |
|
ENTITY_TYPE |
Type of the object. |
|
ADDITIONAL_FILTER |
Additional filters. System parameter. Always has the value of an empty array. |
|
TO_UPDATE |
Array of elements to update. System parameter. Always has the value of an empty array. |
|
TO_UPDATE_ACCESS |
Functions applied to the task when moving to this stage. System parameter. Always has the value of |
Error Handling
HTTP Status: 400
{
"error": "ACCESS_DENIED",
"error_description": "You cannot view stages in this group."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
Description |
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Stages of Kanban and "My Planner": Overview of Methods
- Add a Kanban or "My Plan" Stage task.stages.add
- Update Kanban Stage or "My Plan" task.stages.update
- Check the Ability to Move Task task.stages.canmovetask
- Move Task from One Stage to Another task.stages.movetask
- Delete a Kanban or "My Plan" Stage task.stages.delete