For AI agents: markdown of this page — /docs-content-en/scrum/epics/get.md documentation index — /llms.txt

Get an epic

GET /v1/scrum/epics/:id

Returns a single scrum-project epic by its identifier.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionEpic identifier. List: GET /v1/scrum/epics

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl https://vibecode.bitrix24.com/v1/scrum/epics/7 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/epics/7', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Epic:', data.name)

JavaScript — OAuth application

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.id Typenumber DescriptionEpic identifier
Fielddata.groupId Typenumber DescriptionEpic's scrum project. List: GET /v1/workgroups
Fielddata.name Typestring DescriptionEpic name
Fielddata.description Typestring DescriptionEpic description
Fielddata.createdBy Typenumber DescriptionEpic author. List: GET /v1/users
Fielddata.modifiedBy Typenumber DescriptionWho edited the epic last. 0 if it was never edited. List: GET /v1/users
Fielddata.color Typestring DescriptionEpic color in HEX format
Fielddata.files Typearray DescriptionEpic attachment file IDs, e.g. [417]

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 7,
    "groupId": 45,
    "name": "Reports",
    "description": "Summary reports by sprint",
    "createdBy": 1,
    "modifiedBy": 1,
    "color": "#69dafc",
    "files": [417]
  }
}

For an epic with no attachments, files is an empty array [].

Error response example

404 — not found:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS Descriptionid is not a positive integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo epic exists with the given id
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the task scope
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured tokens

Full list of common API errors — Errors.

See also