Querying Sprints Based on the Update Interval

Function

This API is used to query sprints based on the update interval.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /v3/version/find-version

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
projectId	Yes	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: The value must contain 32 characters. Digits and letters are allowed. Value range: N/A Default value: N/A
updated_time_interval	No	String	Definition: Update interval. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result of the sprint query.
status	String	Definition: Response status of the current sprint list. Value range: success: The response is successful. error: The response failed.

**Table 4** result
Parameter	Type	Description
versions	Array of versions objects	Definition: Returned sprints.
total_count	Integer	Definition: Total number of sprints. Value range: N/A

**Table 5** versions
Parameter	Type	Description
id	Integer	Definition: Unique ID of a sprint. Value range: N/A
name	String	Definition: Sprint name. Value range: N/A
status	String	Definition: Current status of a sprint. Value range: 0: not started 1: ongoing 2: closed
project_id	String	Definition: Unique ID of the project to which a sprint belongs. Value range: N/A
due_date	String	Definition: End date of a sprint. The value is in timestamp format, for example, 1756656000000. Value range: N/A
effective_date	String	Definition: Effective date of a sprint. The value is in timestamp format, for example, 1756656000000. Value range: N/A
created_on	String	Definition: Sprint creation time. The value is in timestamp format, for example, 1756656000000. Value range: N/A
updated_on	String	Definition: Last update time of a sprint. The value is in timestamp format, for example, 1756656000000. Value range: N/A
start_date	String	Definition: Start date of a sprint (in timestamp format, for example, 1756656000000). Value range: N/A
is_current	String	Definition: Whether the sprint is the current version. Value range: N/A
program_version_id	String	Definition: ID of the associated program version. Value range: N/A
done_ratio	Integer	Definition: Sprint progress, in percentage. Value range: N/A
is_deleted	Integer	Definition: Whether the sprint has been deleted. Value range: 0 (not deleted) 1 (deleted)
status_option	Array of status_option objects	Definition: Sprint status option list. Value range: N/A
project	project object	Definition: Project to which a sprint belongs. Value range: N/A
issue_info	issue_info object	Definition: Statistics about sprint-related issues. Value range: N/A

**Table 6** status_option
Parameter	Type	Description
id	String	Definition: Sprint status ID. Value range: 0: not started 1: ongoing 2: closed
name	String	Definition: Sprint status name. Value range: To Do, Doing, and Done

**Table 7** project
Parameter	Type	Description
name	String	Definition: Name of the project to which a sprint belongs. Value range: N/A
id	Integer	Definition: Digital ID of the project to which a sprint belongs. Value range: N/A

**Table 8** issue_info
Parameter	Type	Description
total	Integer	Definition: Total number of issues. Value range: N/A
type_info	Array of strings	Definition: Statistics on different types of issues. Value range: N/A
closed	String	Definition: Number of closed issues. Value range: N/A
un_closed	String	Definition: Number of unclosed issues. Value range: N/A

Example Requests

{endpoint}/v1/scrum/getScrumList?projectId=5192de5eb435430c8cd41c6ae6028848

Example Responses

Status code: 200

{
  "result" : {
    "versions" : [ {
      "id" : 26664788,
      "name" : "111",
      "status" : "0",
      "project_id" : "35138974",
      "due_date" : "2025/09/01",
      "effective_date" : "1756656000000",
      "created_on" : "2025-08-05T17:52:19Z",
      "updated_on" : "2025-08-05T17:52:19Z",
      "start_date" : "2025/08/18",
      "is_current" : "1",
      "program_version_id" : "-1",
      "done_ratio" : 0,
      "is_deleted" : 0,
      "status_option" : [ {
        "id" : "0",
        "name" : "To Do"
      }, {
        "id" : "1",
        "name" : "Developing"
      }, {
        "id" : "2",
        "name" : "Done"
      } ],
      "project" : {
        "name" : "DevOps Full-Process Sample Project XXXX",
        "id" : 35138974
      },
      "issue_info" : {
        "total" : 0,
        "type_info" : [ ],
        "closed" : "0",
        "un_closed" : "0"
      }
    }, {
      "id" : 26664721,
      "name" : "Changing the Sprint Name",
      "status" : "1",
      "project_id" : "35138974",
      "due_date" : "2025/08/02",
      "effective_date" : "1754064000000",
      "created_on" : "2025-08-05T14:26:27Z",
      "updated_on" : "2025-08-05T16:03:09Z",
      "start_date" : "2025/07/19",
      "is_current" : "2",
      "program_version_id" : "-1",
      "done_ratio" : 0,
      "is_deleted" : 0,
      "status_option" : [ {
        "id" : "0",
        "name" : "To Do"
      }, {
        "id" : "1",
        "name" : "Developing"
      }, {
        "id" : "2",
        "name" : "Done"
      } ],
      "project" : {
        "name" : "DevOps Full-Process Sample Project XXXX",
        "id" : 35138974
      },
      "issue_info" : {
        "total" : 0,
        "type_info" : [ ],
        "closed" : "0",
        "un_closed" : "0"
      }
    }, {
      "id" : 26658716,
      "name" : "Sprint 1",
      "status" : "2",
      "project_id" : "35138974",
      "due_date" : "2025/06/20",
      "effective_date" : "1750348800000",
      "created_on" : "2025-07-21T15:54:23Z",
      "updated_on" : "2025-08-05T15:41:05Z",
      "start_date" : "2025/06/09",
      "is_current" : "2",
      "program_version_id" : "-1",
      "done_ratio" : 100,
      "is_deleted" : 0,
      "status_option" : [ {
        "id" : "0",
        "name" : "To Do"
      }, {
        "id" : "1",
        "name" : "Developing"
      }, {
        "id" : "2",
        "name" : "Done"
      } ],
      "project" : {
        "name" : "DevOps Full-Process Sample Project XXXX",
        "id" : 35138974
      },
      "issue_info" : {
        "total" : 11,
        "type_info" : [ {
          "total" : 5,
          "name" : "Task",
          "closed" : "5",
          "id" : "2",
          "un_closed" : "0"
        }, {
          "total" : 3,
          "name" : "Bug",
          "closed" : "3",
          "id" : "3",
          "un_closed" : "0"
        }, {
          "total" : 3,
          "name" : "Story",
          "closed" : "3",
          "id" : "7",
          "type" : "string",
          "un_closed" : "0"
        } ],
        "closed" : "11",
        "un_closed" : "0"
      }
    } ],
    "total_count" : 3
  },
  "status" : "success"
}