Get the list of sprints tasks.api.scrum.sprint.list

Scope: task

Who can execute the method: any user

The method tasks.api.scrum.sprint.list returns a list of sprints.

This method is similar to other methods with filtering by list.

Method parameters

Name `type`	Description
order `object`	An object for sorting the result. The object format is `{'sorting_field': 'sorting_direction' [, ...]}`. Available fields are described in the table below. Sorting direction can take the following values: `asc` — ascending `desc` — descending
filter `object`	An object in the format `{'filter_field': 'filter_value' [, ...]}`. Available fields are described in the table below
select `object`	An array of record fields that will be returned by the method. You can specify only the fields that are necessary. If the array contains the value `"*"`, all available fields will be returned. The default value is an empty array `array()`. In this case, all fields of the main query table will be returned
start `integer`	The page number of the output. Works for https requests

Available filter fields

Name `type`	Description
ID `integer`	Sprint identifier
GROUP_ID `integer`	Scrum identifier
ENTITY_TYPE `string`	Entity type
NAME `string`	Name
SORT `integer`	Sorting
CREATED_BY `integer`	Created by
MODIFIED_BY `integer`	Modified by
DATE_START `string`	Start date
DATE_END `string`	End date
STATUS `string`	Status
INFO `object`	Information

Code examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (oAuth)

PHP

BX24.js

PHP CRest

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: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        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: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        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: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than 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'); // include CRest PHP SDK
        
        // execute a request to the REST API
        $result = CRest::call(
            'tasks.api.scrum.sprint.list',
            [
                'filter' => [
                    'GROUP_ID' => 1,
                    '>=DATE_END' => '2024-07-19T15:03:01+00:00'
                ]
            ]
        );
        
        // Process the response from Bitrix24
        if (isset($result['error'])) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }

Response handling

HTTP status: 200

[
            {
                "id": 2,
                "groupId": 143,
                "entityType": "sprint",
                "name": "Sprint 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"
            }
        ]

Returned data

Name `type`	Description
result `object`	An object containing data about the sprint
id `integer`	Sprint identifier
groupId `integer`	Identifier of the group (Scrum) to which the sprint belongs
entityType `string`	Entity type (in this case `sprint`)
name `string`	Name of the sprint
goal `string`	Goal of the sprint. Set only in the interface when starting the sprint
sort `integer`	Sorting
createdBy `integer`	Identifier of the user who created the sprint
modifiedBy `integer`	Identifier of the user who modified the sprint
dateStart `string`	Start date of the sprint in `ISO 8601` format
dateEnd `string`	End date of the sprint in `ISO 8601` format
status `string`	Status of the sprint

Error handling

HTTP status: 400

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible error codes

Code	Error message	Description
`0`	`Could not load list`	No sprints found with the specified filters

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue exploring

Get Sprint Fields by Its Identifier

Delete Sprint

Get the list of sprints tasks.api.scrum.sprint.list

Method parametersMethod parameters

Available filter fieldsAvailable filter fields

Code examplesCode examples

Response handlingResponse handling

Returned dataReturned data

Error handlingError handling

Possible error codesPossible error codes

Statuses and System Error CodesStatuses and System Error Codes

Continue exploringContinue exploring