# Active sprint

`GET /v1/scrum/sprints/active`

Returns the current active sprint of one scrum project. If the project has no active sprint, the request remains successful and returns `data: null`.

## Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `groupId` (query) | number | Yes | Scrum project ID. Obtain it from [`GET /v1/workgroups`](/docs/entities/workgroups/list) |

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/scrum/sprints/active?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/sprints/active?groupId=45', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data: sprint } = await res.json()
console.log(sprint?.name ?? 'No active sprint')
```

### JavaScript — OAuth application

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

const { data: sprint } = await res.json()
console.log(sprint?.name ?? 'No active sprint')
```

## Response fields

| Field | Type | Description |
|-------|------|-------------|
| `success` | boolean | Always `true` on success |
| `data` | object \| null | Active sprint, or `null` when none exists |
| `data.id` | number | Sprint ID. The same value as `sprintId` in stage operations |
| `data.groupId` | number | Scrum project ID |
| `data.entityType` | string | Record type, `sprint` |
| `data.name` | string | Sprint name |
| `data.goal` | string | Sprint goal |
| `data.sort` | number | Sprint order within the project |
| `data.createdBy` | number | ID of the sprint author |
| `data.modifiedBy` | number | ID of the employee who last changed the sprint |
| `data.dateStart` | string | Sprint start in ISO 8601 format |
| `data.dateEnd` | string | Sprint end in ISO 8601 format |
| `data.status` | string | Always `active` for a returned record |

## Response example

```json
{
  "success": true,
  "data": {
    "id": 11,
    "groupId": 45,
    "entityType": "sprint",
    "name": "Sprint 3",
    "goal": "",
    "sort": 0,
    "createdBy": 29,
    "modifiedBy": 29,
    "dateStart": "2023-09-15T01:00:00+00:00",
    "dateEnd": "2023-09-29T01:00:00+00:00",
    "status": "active"
  }
}
```

## Error response example

400 — `groupId` is missing:

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

## Errors

| HTTP | Code | Description |
|------|------|-------------|
| 400 | `INVALID_PARAMS` | `groupId` is missing or is not a positive integer |
| 401 | `TOKEN_MISSING` | The key has no tokens configured |
| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |
| 422 | `BITRIX_ERROR` | Bitrix24 refused to read the project's sprints |

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

## Known specifics

- A scrum project can have at most one active sprint.
- No active sprint is a normal project state, so the response contains `data: null` rather than a `404` error.

## See also

- [List sprints](/docs/scrum/sprints/list)
- [Sprint by ID](/docs/scrum/sprints/get)
- [Scrum kanban stages](/docs/scrum/stages)
- [Scrum](/docs/scrum)