# tasks.api.scrum.sprint.list

URL: https://chugunov.pro/api-bitrix24/sonet-group/scrum/sprint/tasks-api-scrum-sprint-list/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список спринтов
Scope: `task`
Кто может выполнять метод: любой пользователь

## Описание

Метод `tasks.api.scrum.sprint.list` возвращает список спринтов.

Метод аналогичен другим методам с фильтрацией по списку.

## Параметры

- `order` `object` — необязательный. Объект для сортировки результата. Объект вида `{'поле_сортировки': 'направление сортировки' [, ...]}`. Доступные поля описаны в таблице [ниже](#fields).
  Направление сортировки может принимать значения:
  - `asc` — по возрастанию
  - `desc` — по убыванию
- `filter` `object` — необязательный. Объект вида `{'фильтруемое_поле': 'значение фильтра' [, ...]}`. Доступные поля описаны в таблице [ниже](#fields)
- `select` `object` — необязательный. Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. 
  Если в массиве присутствует значение `"*"`, то будут возвращены все доступные поля.
  Значение по умолчанию — пустой массив `array()`. В этом случае будут возвращены все поля основной таблицы запроса
- `start` `integer` — необязательный. Номер страницы вывода. Работает для https запросов

### Доступные поля фильтра

- `ID` `integer` — необязательный. Идентификатор спринта
- `GROUP_ID` `integer` — необязательный. Идентификатор Скрама
- `ENTITY_TYPE` `string` — необязательный. Тип элемента
- `NAME` `string` — необязательный. Имя
- `SORT` `integer` — необязательный. Сортировка
- `CREATED_BY` `integer` — необязательный. Кем создан
- `MODIFIED_BY` `integer` — необязательный. Кем изменен
- `DATE_START` `string` — необязательный. Дата запуска
- `DATE_END` `string` — необязательный. Дата окончания
- `STATUS` `string` — необязательный. Статус
- `INFO` `object` — необязательный. Информация

## Ответ

HTTP-статус: 200

```json
[
    {
        "id": 2,
        "groupId": 143,
        "entityType": "sprint",
        "name": "Спринт 1",
        "goal": "",
        "sort": 1,
        "createdBy": 1,
        "modifiedBy": 1,
        "dateStart": "2024-07-19T15:03:01+00:00",
        "dateEnd": "2024-08-02T15:03:01+00:00",
        "status": "planned"
    },
    {
        "id": 3,
        "groupId": 1,
        "entityType": "sprint",
        "name": "Sprint 1",
        "goal": "",
        "sort": 1,
        "createdBy": 1,
        "modifiedBy": 1,
        "dateStart": "2021-11-21T22:00:00+00:00",
        "dateEnd": "2021-11-28T22:00:00+00:00",
        "status": "planned"
    }
]
```

### Возвращаемые данные

- `result` `object`. Объект, содержащий данные о спринте
- `id` `integer`. Идентификатор спринта
- `groupId` `integer`. Идентификатор группы (Скрама), к которой относится спринт
- `entityType` `string`. Тип сущности (в данном случае `sprint`)
- `name` `string`. Название спринта
- `goal` `string`. Цель спринта. Устанавливается только в интерфейсе при запуске спринта
- `sort` `integer`. Сортировка
- `createdBy` `integer`. Идентификатор пользователя, создавшего спринт
- `modifiedBy` `integer`. Идентификатор пользователя, изменившего спринт
- `dateStart` `string`. Дата начала спринта в формате `ISO 8601`
- `dateEnd` `string`. Дата окончания спринта в формате `ISO 8601`
- `status` `string`. Статус спринта

## Ошибки

HTTP-статус: 400

```json
{
    "error": 0,
    "error_description": "Could not load list"
}
```

- `0` — `Could not load list`. Не найдено ни одного спринта с указанными фильтрами

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"filter": {
    "GROUP_ID": 1,
    ">=DATE_END": "2024-07-19T15:03:01+00:00"
}
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.list
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"filter": {
    "GROUP_ID": 1,
    ">=DATE_END": "2024-07-19T15:03:01+00:00"
},
"auth": "YOUR_ACCESS_TOKEN"
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.list
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each sprint returned in result[]
type Sprint = {
  id: number
  groupId: number
  entityType: string
  name: string
  goal: string
  sort: number
  createdBy: number
  modifiedBy: number
  dateStart: ISODate | null
  dateEnd: ISODate | null
  status: string
}

const groupId = 1

// tasks.api.scrum.sprint.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
try {
  const response = await $b24.actions.v2.call.make<Sprint[]>({
    method: 'tasks.api.scrum.sprint.list',
    params: {
      filter: {
        GROUP_ID: groupId,
        '>=DATE_END': new Date().toISOString(),
      },
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Sprints:', result.length, result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listScrumSprints() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const groupId = 1

      // tasks.api.scrum.sprint.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'tasks.api.scrum.sprint.list',
        params: {
          filter: {
            GROUP_ID: groupId,
            '>=DATE_END': new Date().toISOString(),
          },
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Sprints:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listScrumSprints)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.tasks.api.scrum.sprint.list(
        filter={
            "GROUP_ID": 1,
            ">=DATE_END": "2024-07-19T15:03:01+00:00",
        },
        start=0,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
$groupId = 1;

try {
    $response = $b24Service
        ->core
        ->call(
            'tasks.api.scrum.sprint.list',
            [
                'filter' => [
                    'GROUP_ID'    => $groupId,
                    '>=DATE_END' => new DateTime(),
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching sprint list: ' . $e->getMessage();
}
```

### BX24.js

```js
const groupId = 1;
BX24.callMethod(
    'tasks.api.scrum.sprint.list',
    {
        filter: {
            GROUP_ID: groupId,
            '>=DATE_END': new Date()
        }
    },
    function(res)
    {
        console.log(res);
    }
);
```

### PHP CRest

```php
require_once('crest.php'); // подключение CRest PHP SDK

// выполнение запроса к REST API
$result = CRest::call(
    'tasks.api.scrum.sprint.list',
    [
        'filter' => [
            'GROUP_ID' => 1,
            '>=DATE_END' => '2024-07-19T15:03:01+00:00'
        ]
    ]
);

// Обработка ответа от Битрикс24
if (isset($result['error'])) {
    echo 'Error: '.$result['error_description'];
} else {
    print_r($result['result']);
}
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.sprint.list", b24.Params{
	"filter": b24.Params{
		"GROUP_ID":   1,
		">=DATE_END": "2024-07-19T15:03:01+00:00",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("tasks.api.scrum.sprint.list: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-list.html