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

Получить спринт

GET /v1/scrum/sprints/:id

Возвращает один спринт по идентификатору независимо от его статуса: planned, active или completed.

Параметры

Параметр Тип Обязательный Описание
id (path) number Да ID спринта. Получите его через список спринтов или активный спринт

Примеры

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

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

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

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

const { data: sprint } = await res.json()
console.log(sprint.name, sprint.status)

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

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

const { data: sprint } = await res.json()
console.log(sprint.name, sprint.status)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Спринт
data.id number ID спринта
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 planned, active или completed

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

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"
  }
}

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

404 — спринт не найден:

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

Ошибки

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

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

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