## List epics

`GET /v1/scrum/epics`

Returns the epics of the Bitrix24 account's scrum projects, optionally for a specific scrum project.

## Parameters

| Parameter | Type | Req. | Default | Description |
|----------|-----|:-----:|-----------|---------|
| `groupId` (query) | number | no | — | Filter by scrum project. List: `GET /v1/workgroups` |
| `limit` (query) | number | no | 200 | Maximum epics in the response. Up to 1000 |

When `limit > 50`, the API automatically fetches additional records and returns them as a single array, so a Bitrix24 account with more than 50 epics is exported in full.

## Examples

### curl — personal key

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

### curl — OAuth app

```bash
curl "https://vibecode.bitrix24.com/v1/scrum/epics?groupId=45" \
  -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?groupId=45', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Epics:', data.length)
```

### JavaScript — OAuth app

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of epics |
| `data[].id` | number | Epic identifier |
| `data[].groupId` | number | Epic's scrum project. List: `GET /v1/workgroups` |
| `data[].name` | string | Epic name |
| `data[].description` | string | Epic description |
| `data[].createdBy` | number | Epic author. List: `GET /v1/users` |
| `data[].modifiedBy` | number | Who edited the epic last. `0` if it was never edited. List: `GET /v1/users` |
| `data[].color` | string | Epic color in HEX format |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 3,
      "groupId": 45,
      "name": "Authorization",
      "description": "",
      "createdBy": 29,
      "modifiedBy": 0,
      "color": "#c4baed"
    },
    {
      "id": 5,
      "groupId": 45,
      "name": "Payments",
      "description": "",
      "createdBy": 29,
      "modifiedBy": 0,
      "color": "#ffcbd8"
    },
    {
      "id": 7,
      "groupId": 45,
      "name": "Reports",
      "description": "Summary reports by sprint",
      "createdBy": 1,
      "modifiedBy": 1,
      "color": "#69dafc"
    }
  ]
}
```

## Error response example

400 — validation failed:

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

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `groupId` or `limit` is not a positive integer |
| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |
| 401 | `TOKEN_MISSING` | The key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [Get an epic](/docs/scrum/epics/get)
- [Create an epic](/docs/scrum/epics/create)
- [Scrum epics](/docs/scrum/epics)
- [Workgroups](/docs/entities/workgroups)