## List stages

`GET /v1/scrum/sprints/:sprintId/stages`

Returns the columns of one sprint board. A planned sprint whose board does not exist yet returns an empty array — that is not an error.

## Path parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `sprintId` | number | yes | Sprint ID. Obtain with `GET /v1/scrum/sprints?groupId=N` |

The generic `filter` parameter is not applied by this endpoint. By default, the API preserves the previous HTTP 200 response and data, adds `Warning: 299 - "filter is not supported on this endpoint and was ignored"`, and records unsupported-filter use in the server log.

## Examples

### curl — personal key

```bash
curl https://vibecode.bitrix24.com/v1/scrum/sprints/11/stages \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl https://vibecode.bitrix24.com/v1/scrum/sprints/11/stages \
  -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/sprints/11/stages', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.map((stage) => stage.name))
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/sprints/11/stages', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    Authorization: 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log(data.map((stage) => stage.name))
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | `true` on success |
| `data` | array | Columns of the sprint board. Empty if the sprint board has not been created yet |
| `data[].id` | number | Stage ID |
| `data[].name` | string | Column name |
| `data[].type` | string | `NEW`, `WORK` or `FINISH` |
| `data[].sort` | number | Column order |
| `data[].color` | string | Color, six characters without `#` |
| `data[].sprintId` | number | Sprint ID |

The `id`, `sort` and `sprintId` fields are returned as numbers. A value that is not a decimal integer is returned as `null`.

## Response example

```json
{
    "success": true,
    "data": [
        { "id": 431, "name": "New", "sort": 100, "type": "NEW", "sprintId": 11, "color": "00C4FB" },
        { "id": 433, "name": "In progress", "sort": 200, "type": "WORK", "sprintId": 11, "color": "47D1E2" },
        { "id": 435, "name": "Done", "sort": 300, "type": "FINISH", "sprintId": 11, "color": "75D900" }
    ]
}
```

## Error response example

404 — no sprint with this ID exists:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Sprint not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 200 | `Warning: 299` | The filter is ignored by default; previous data is preserved and the warning is sent in the `Warning` header. |
| 400 (strict mode only) | `UNSUPPORTED_FILTER` | The server mode is disabled by default; until it is enabled, the endpoint preserves HTTP 200 and the previous data. |
| 400 | `INVALID_PARAMS` | `sprintId` is not a positive integer |
| 404 | `ENTITY_NOT_FOUND` | No sprint with this ID exists |
| 422 | `BITRIX_ERROR` | Bitrix24 returned an error the platform could not map to any of the other codes in this table; a permission refusal does NOT land here — it arrives as `403 BITRIX_ACCESS_DENIED` |
| 403 | `BITRIX_ACCESS_DENIED` | The Bitrix24 user the key acts as has no access to the sprint's scrum project |
| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |
| 401 | `TOKEN_MISSING` | The key has no tokens configured |

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

## Known specifics

- **It must be a `sprintId`.** Bitrix24 does not accept a workgroup or backlog ID and answers `404`; the message does not hint that an ID of a different kind was passed.

## See also

- [Create a stage](/docs/scrum/stages/create)
- [Update a stage](/docs/scrum/stages/update)
- [Scrum kanban stages](/docs/scrum/stages)