Получить список стадий канбана или «Моего плана» task.stages.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
taskКто может выполнять метод:
- любой пользователь для стадий «Моего плана»
- любой пользователь с доступом к группе для стадий канбана
Метод task.stages.get получает стадии канбана или «Моего плана».
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityId* |
Идентификатор объекта. Возможные значения:
|
|
isAdmin |
Если установлено |
Примеры кода
Как использовать примеры в документации
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))
Обработка ответа
HTTP-Статус: 200
{
"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
}
}
}
Возвращаемые данные
|
Поле |
Описание |
|
result |
Объект, содержащий данные о стадиях Канбана / Моего плана, ключами которого являются идентификаторы стадий |
|
ID |
Идентификатор стадии |
|
TITLE |
Название |
|
SORT |
Сортировка |
|
COLOR |
Цвет в формате RGB |
|
SYSTEM_TYPE |
Системный тип. Возможные значения: |
|
ENTITY_ID |
Идентификатор объекта, то есть группы или пользователя |
|
ENTITY_TYPE |
Тип объекта. |
|
ADDITIONAL_FILTER |
Дополнительные фильтры. Системный параметр. Всегда имеет значение пустого массива |
|
TO_UPDATE |
Массив элементов для обновления. Системный параметр. Всегда имеет значение пустого массива |
|
TO_UPDATE_ACCESS |
Функции, применяемые к задаче при переносе на эту стадию. Системный параметр. Всегда имеет значение |
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Вы не можете просматривать стадии в этой группе"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Значение |
|
|
Вы не можете просматривать стадии в этой группе |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Стадии канбана и «Моего плана»: обзор методов
- Добавить стадию канбана или «Моего плана» task.stages.add
- Обновить стадию канбана или «Моего плана» task.stages.update
- Проверить возможность перемещения задачи task.stages.canmovetask
- Переместить задачу из одной стадии в другую task.stages.movetask
- Удалить стадию канбана или «Моего плана» task.stages.delete