Help Center/ CodeArts Req/ API Reference/ Application Examples/ Example 2: Querying The Sprint List of a Specified Project
Updated on 2025-05-22 GMT+08:00

Example 2: Querying The Sprint List of a Specified Project

Scenario

This section uses the test001 user as an example to describe how to use an API to query the sprint list of a specified project.

For details about how to call APIs, see Calling APIs.

Constraints

Ensure that the test001 user has created a project in CodeArts Req.

Involved API

Query the sprint list of a specified project of the current user based on the user token.

URI: GET /v4/projects/{project_id}/iterations

For details about the API document, see "Obtaining the Sprint List of a Specified Project."

For details about online API Explorer debugging, see "Obtaining the Sprint List of a Specified Project."

Procedure

  • Request example
    GET https://excample.com/v4/projects/3cea7d4d77134eee8251825918a8bd7a/iterations
  • Response example
    {
     "iterations": [
      {
       "id": 707961817,
       "name": "Sprint 1",
       "description": "",
       "begin_time": "2020/06/07",
       "end_time": "2020/07/06"
      },
      {
       "id": 707961818,
       "name": "Sprint 2",
       "description": "",
       "begin_time": "2020/07/07",
       "end_time": "2020/08/06"
      },
      {
       "id": 707961819,
       "name": "Sprint 3",
       "description": "",
       "begin_time": "2020/08/07",
       "end_time": "2020/09/06"
      }
     ],
     "total": 3
    }