Для 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 Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является положительным целым числом
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP404 КодENTITY_NOT_FOUND ОписаниеСпринт не найден
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отказал в чтении спринта, например у пользователя ключа нет доступа к проекту

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

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