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

`GET /v1/scrum/epics`

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

## Параметры

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

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

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/scrum/epics?groupId=45" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
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 | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `groupId` или `limit` не является положительным целым числом |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `task` |
| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- [Получить эпик](/docs/scrum/epics/get)
- [Создать эпик](/docs/scrum/epics/create)
- [Эпики скрама](/docs/scrum/epics)
- [Рабочие группы](/docs/entities/workgroups)