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

Спринты

Чтение спринтов скрам-проектов: полный доступный список, текущий активный спринт проекта и одна запись по идентификатору. Идентификатор спринта используется в операциях с колонками его доски.

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

Список спринтов

GET /v1/scrum/sprints

Возвращает спринты скрам-проектов портала. Идентификатор из поля id нужен операциям с этапами доски и чтению одного спринта.

Параметры

Параметр Тип По умолч. Описание
groupId (query) number — ID скрам-проекта. Список: GET /v1/workgroups. Без параметра возвращаются все спринты, доступные ключу
limit (query) number 200 Сколько спринтов вернуть, от 1 до 1000

Пагинация. Страницы дочитываются автоматически — ответ приходит одним массивом длиной до limit записей, параметра смещения у метода нет. Значение limit больше 1000 приводится к 1000 без ошибки.

Примеры

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

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

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

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

const { data } = await res.json()
const active = data.filter((sprint) => sprint.status === 'active')
console.log(active.map((sprint) => `${sprint.id}: ${sprint.name}`))

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив спринтов
data[].id number ID спринта. Он же sprintId в операциях с этапами
data[].groupId number ID скрам-проекта. Список: GET /v1/workgroups
data[].entityType string Тип записи. У спринта — sprint
data[].name string Название спринта
data[].goal string Цель спринта. Когда цель не задана, приходит пустая строка
data[].sort number Порядок спринта внутри проекта
data[].createdBy number ID автора спринта. Список: GET /v1/users
data[].modifiedBy number ID сотрудника, изменившего спринт последним. Список: GET /v1/users
data[].dateStart string Начало спринта в формате ISO 8601 со смещением портала
data[].dateEnd string Окончание спринта в формате ISO 8601 со смещением портала
data[].status string planned, active или completed

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 9,
      "groupId": 45,
      "entityType": "sprint",
      "name": "Спринт 2",
      "goal": "",
      "sort": 0,
      "createdBy": 29,
      "modifiedBy": 29,
      "dateStart": "2023-09-01T01:00:00+03:00",
      "dateEnd": "2024-04-16T12:20:42+03:00",
      "status": "completed"
    },
    {
      "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"
    },
    {
      "id": 21,
      "groupId": 53,
      "entityType": "sprint",
      "name": "Спринт 6",
      "goal": "",
      "sort": 0,
      "createdBy": 1,
      "modifiedBy": 1,
      "dateStart": "2024-06-05T01:00:00+03:00",
      "dateEnd": "2024-06-19T01: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 не положительное целое число
400 INVALID_PARAMS limit не положительное целое число
422 BITRIX_ERROR Битрикс24 вернул ошибку, например «Access denied», если у пользователя ключа нет доступа к скрам-проекту
403 SCOPE_DENIED Ключу не хватает скоупа task
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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

  • Без groupId спринты разных проектов идут вперемешку. Ответ не сгруппирован по проектам, поэтому разбирайте выдачу на своей стороне по полю groupId каждой записи.
  • В выдаче остаются завершённые спринты. Ответ не ограничен текущим спринтом проекта. Если нужен только текущий, используйте GET /v1/scrum/sprints/active.

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