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

Активный спринт

GET /v1/scrum/sprints/active

Возвращает текущий активный спринт одного скрам-проекта. Если активного спринта сейчас нет, запрос остаётся успешным и возвращает data: null.

Параметры

Параметр Тип Обязательный Описание
groupId (query) number Да ID скрам-проекта. Получите его через GET /v1/workgroups

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/scrum/sprints/active?groupId=45" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/scrum/sprints/active?groupId=45" \
  -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/active?groupId=45', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data: sprint } = await res.json()
console.log(sprint?.name ?? 'Активного спринта нет')

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

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

const { data: sprint } = await res.json()
console.log(sprint?.name ?? 'Активного спринта нет')

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object | null Активный спринт или null, если его нет
data.id number ID спринта. Он же sprintId в операциях с этапами
data.groupId number ID скрам-проекта
data.entityType string Тип записи, sprint
data.name string Название спринта
data.goal string Цель спринта
data.sort number Порядок спринта внутри проекта
data.createdBy number ID автора спринта
data.modifiedBy number ID сотрудника, изменившего спринт последним
data.dateStart string Начало спринта в формате ISO 8601
data.dateEnd string Окончание спринта в формате ISO 8601
data.status string Для найденной записи всегда active

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

JSON 
{
  "success": true,
  "data": {
    "id": 11,
    "groupId": 45,
    "entityType": "sprint",
    "name": "Спринт 3",
    "goal": "",
    "sort": 0,
    "createdBy": 29,
    "modifiedBy": 29,
    "dateStart": "2023-09-15T01:00:00+03:00",
    "dateEnd": "2023-09-29T01:00:00+03:00",
    "status": "active"
  }
}

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

400 — groupId не передан:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupId must be a positive integer"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS groupId не передан или не является положительным целым числом
401 TOKEN_MISSING У ключа нет настроенных токенов
403 SCOPE_DENIED Ключу не хватает скоупа task
422 BITRIX_ERROR Битрикс24 отказал в чтении спринтов проекта

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

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

  • У одного скрам-проекта может быть не больше одного активного спринта.
  • Отсутствие активного спринта — нормальное состояние проекта, поэтому ответ содержит data: null, а не ошибку 404.

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