Get a List of Sprints 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
        

// 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)
        }
        

<!-- 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>
        

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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {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'); // connecting CRest PHP SDK
        
        // executing 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'
                ]
            ]
        );
        
        // Processing the response from Bitrix24
        if (isset($result['error'])) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }
        

// client and ctx are already created — see the Go SDK section
        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)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)