Для AI-агентов: markdown этой страницы — /docs-content/scrum/stages.md индекс документации — /llms.txt

Этапы Scrum-канбана

Колонки доски спринта: создание, чтение и изменение. Этапы принадлежат спринту, а не рабочей группе — у разных спринтов одного проекта наборы колонок независимы.

Скоуп: task | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

Как получить `sprintId`

Всем операциям с этапами нужен идентификатор спринта. Возьмите его в списке спринтов или запросите активный спринт проекта.

Список этапов

GET /v1/scrum/sprints/:sprintId/stages

Возвращает колонки доски одного спринта. У запланированного спринта, доска которого ещё не создана, вернётся пустой массив — это не ошибка.

Параметры пути

Параметр Тип Обяз. Описание
sprintId number да ID спринта. Получить: GET /v1/scrum/sprints?groupId=N

Примеры

curl — личный ключ

Terminal 
curl https://vibecode.bitrix24.tech/v1/scrum/sprints/11/stages \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl https://vibecode.bitrix24.tech/v1/scrum/sprints/11/stages \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/sprints/11/stages', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.map((stage) => stage.name))

Поля ответа

Поле Тип Описание
id number ID этапа
name string Название колонки
type string NEW, WORK или FINISH
sort number Порядок колонки
color string Цвет, шесть символов без #
sprintId number ID спринта

Битрикс24 отдаёт эти поля строками; платформа приводит id, sort и sprintId к числам. Значение, не являющееся десятичным целым, приезжает как null.

Пример ответа

JSON 
{
    "success": true,
    "data": [
        { "id": 431, "name": "Новые", "sort": 100, "type": "NEW", "sprintId": 11, "color": "00C4FB" },
        { "id": 433, "name": "Выполняются", "sort": 200, "type": "WORK", "sprintId": 11, "color": "47D1E2" },
        { "id": 435, "name": "Сделаны", "sort": 300, "type": "FINISH", "sprintId": 11, "color": "75D900" }
    ]
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS sprintId не положительное целое
404 ENTITY_NOT_FOUND Спринта с таким ID не существует
422 BITRIX_ERROR Битрикс24 вернул ошибку, которую платформа не отнесла ни к одному из остальных кодов этой таблицы; отказ по правам сюда НЕ попадает — он приходит как 403 BITRIX_ACCESS_DENIED
403 BITRIX_ACCESS_DENIED У пользователя Битрикс24, от имени которого работает ключ, нет доступа к скрам-проекту спринта
403 SCOPE_DENIED Ключу не хватает скоупа task
401 TOKEN_MISSING У ключа нет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Нужен именно sprintId. ID рабочей группы или бэклога Битрикс24 не примет и ответит 404 — сообщение при этом не подсказывает, что передан идентификатор другого рода.

Смотрите также