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

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

GET /v1/scrum/epics

Возвращает эпики скрам-проектов портала, опционально по конкретному скрам-проекту.

Параметры

Параметр Тип Обяз. По умолч. Описание
ПараметрgroupId (query) Типnumber Обяз.нет По умолч.— ОписаниеФильтр по скрам-проекту. Список: GET /v1/workgroups
Параметрlimit (query) Типnumber Обяз.нет По умолч.200 ОписаниеМаксимум эпиков в ответе. Максимум 1000

При limit > 50 API автоматически докачивает записи и возвращает их одним массивом, поэтому портал с более чем 50 эпиками выгружается полностью.

Общий параметр 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/epics?groupId=45" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/scrum/epics?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/epics?groupId=45', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Эпиков:', data.length)

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеМассив эпиков
Полеdata[].id Типnumber ОписаниеИдентификатор эпика
Полеdata[].groupId Типnumber ОписаниеСкрам-проект эпика. Список: GET /v1/workgroups
Полеdata[].name Типstring ОписаниеНазвание эпика
Полеdata[].description Типstring ОписаниеОписание эпика
Полеdata[].createdBy Типnumber ОписаниеАвтор эпика. Список: GET /v1/users
Полеdata[].modifiedBy Типnumber ОписаниеКто изменил эпик последним. 0, если изменений не было. Список: GET /v1/users
Полеdata[].color Типstring ОписаниеЦвет эпика в формате HEX

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3,
      "groupId": 45,
      "name": "Авторизация",
      "description": "",
      "createdBy": 29,
      "modifiedBy": 0,
      "color": "#c4baed"
    },
    {
      "id": 5,
      "groupId": 45,
      "name": "Платежи",
      "description": "",
      "createdBy": 29,
      "modifiedBy": 0,
      "color": "#ffcbd8"
    },
    {
      "id": 7,
      "groupId": 45,
      "name": "Отчёты",
      "description": "Сводные отчёты по спринтам",
      "createdBy": 1,
      "modifiedBy": 1,
      "color": "#69dafc"
    }
  ]
}

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

400 — нарушена валидация:

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

Ошибки

HTTP Код Описание
HTTP200 КодWarning: 299 ОписаниеФильтр игнорируется по умолчанию; прежние данные сохраняются, предупреждение передаётся заголовком Warning.
HTTP400 только при включённом строгом режиме КодUNSUPPORTED_FILTER ОписаниеСерверный режим выключен по умолчанию; до его включения эндпоинт сохраняет HTTP 200 и прежние данные.
HTTP400 КодINVALID_PARAMS ОписаниеgroupId или limit не является положительным целым числом
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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