Получить список спринтов tasks.api.scrum.sprint.list

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: task

Кто может выполнять метод: любой пользователь

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

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

Параметры метода

Название
тип

Описание

order
object

Объект для сортировки результата. Объект вида {'поле_сортировки': 'направление сортировки' [, ...]}. Доступные поля описаны в таблице ниже.

Направление сортировки может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

filter
object

Объект вида {'фильтруемое_поле': 'значение фильтра' [, ...]}. Доступные поля описаны в таблице ниже

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

Информация

Примеры кода

Как использовать примеры в документации

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 -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
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        const groupId = 1;
        try {
          const response = await $b24.callListMethod(
            'tasks.api.scrum.sprint.list',
            {
              filter: {
                GROUP_ID: groupId,
                '>=DATE_END': new Date()
              }
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        const groupId = 1;
        try {
          const generator = $b24.fetchListMethod('tasks.api.scrum.sprint.list', {
            filter: {
              GROUP_ID: groupId,
              '>=DATE_END': new Date()
            }
          }, 'ID');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        const groupId = 1;
        try {
          const response = await $b24.callMethod('tasks.api.scrum.sprint.list', {
            filter: {
              GROUP_ID: groupId,
              '>=DATE_END': new Date()
            }
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
$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();
        }
        
const groupId = 1;
        BX24.callMethod(
            'tasks.api.scrum.sprint.list',
            {
                filter: {
                    GROUP_ID: groupId,
                    '>=DATE_END': new Date()
                }
            },
            function(res)
            {
                console.log(res);
            }
        );
        
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']);
        }

Обработка ответа

HTTP-статус: 200

[
            {
                "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

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Cообщение об ошибке

Описание

0

Could not load list

Не найдено ни одного спринта с указанными фильтрами

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить поля спринта по его идентификатору
Следующая
Удалить спринт