task.stages.get
Получить список стадий канбана или «Моего плана»
Описание
Метод task.stages.get получает стадии канбана или «Моего плана».
Параметры
entityId
integer
обязательный
Идентификатор объекта.
Возможные значения:
- ID группы — метод получит стадии канбана группы. При недостаточном уровне прав выводится ошибка доступа
- 0 — метод получит стадии «Моего плана» текущего пользователя
isAdmin
boolean
необязательный
Если установлено true, то проверки прав происходить не будет. При условии, что запрашивающий является администратором портала
Примеры запроса
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",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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'); // подключение CRest PHP SDK
$entityId = 0;
// выполнение запроса к REST API
$result = CRest::call(
'task.stages.get',
[
'entityId' => $entityId
]
);
// Обработка ответа от Битрикс24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
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("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))
Ответ
{
"result": {
"5": {
"ID": "5",
"TITLE": "Не спланированы",
"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": "Сделаю на неделе",
"SORT": "200",
"COLOR": "47D1E2",
"SYSTEM_TYPE": null,
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
}
}
}
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Вы не можете просматривать стадии в этой группе"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Вы не можете просматривать стадии в этой группе |

