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

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

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

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

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

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

Общий параметр filter этим эндпоинтом не применяется. По умолчанию API сохраняет прежний ответ HTTP 200 и прежние данные, добавляет заголовок Warning: 299 - "filter is not supported on this endpoint and was ignored", а сервер фиксирует использование неподдерживаемого фильтра в журнале.

Примеры

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))

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типarray ОписаниеМассив колонок доски спринта. Пустой, если доска спринта ещё не создана
Полеdata[].id Типnumber ОписаниеID этапа
Полеdata[].name Типstring ОписаниеНазвание колонки
Полеdata[].type Типstring ОписаниеNEW, WORK или FINISH
Полеdata[].sort Типnumber ОписаниеПорядок колонки
Полеdata[].color Типstring ОписаниеЦвет, шесть символов без #
Полеdata[].sprintId Типnumber ОписаниеID спринта

Поля 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" }
    ]
}

Пример ответа при ошибке

404 — спринта с таким ID не существует:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Sprint not found"
  }
}

Ошибки

HTTP Код Описание
HTTP200 КодWarning: 299 ОписаниеФильтр игнорируется по умолчанию; прежние данные сохраняются, предупреждение передаётся заголовком Warning.
HTTP400 только при включённом строгом режиме КодUNSUPPORTED_FILTER ОписаниеСерверный режим выключен по умолчанию; до его включения эндпоинт сохраняет HTTP 200 и прежние данные.
HTTP400 КодINVALID_PARAMS ОписаниеsprintId не положительное целое
HTTP404 КодENTITY_NOT_FOUND ОписаниеСпринта с таким ID не существует
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 вернул ошибку, которую платформа не отнесла ни к одному из остальных кодов этой таблицы; отказ по правам сюда НЕ попадает — он приходит как 403 BITRIX_ACCESS_DENIED
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя Битрикс24, от имени которого работает ключ, нет доступа к скрам-проекту спринта
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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

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

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