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

Получить эпик

GET /v1/scrum/epics/:id

Возвращает один эпик скрам-проекта по его идентификатору.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеИдентификатор эпика. Список: GET /v1/scrum/epics

Примеры

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

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

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

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Поле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
Полеdata.files Типarray ОписаниеID вложений эпика, например [417]

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

JSON 
{
  "success": true,
  "data": {
    "id": 7,
    "groupId": 45,
    "name": "Отчёты",
    "description": "Сводные отчёты по спринтам",
    "createdBy": 1,
    "modifiedBy": 1,
    "color": "#69dafc",
    "files": [417]
  }
}

У эпика без вложений files — пустой массив [].

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

404 — не найден:

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является положительным целым числом
HTTP404 КодENTITY_NOT_FOUND ОписаниеЭпика с указанным id нет
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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