Getting all sprints of a board

Use this request to get the parameters of a board's sprints.

GET

https://api.tracker.yandex.net/v3/boards/<board_ID>/sprints

Query format

To get the parameters of all sprints for a board, use an HTTP GET request:

GET /v3/boards/<board_ID>/sprints
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers
  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to AdministrationOrganizations and copy the value from the ID field.

Resource
Parameter Description Data type
<board_ID> Board ID String

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains a JSON array with board sprint parameters.

[
  {
  "self": "https://api.tracker.yandex.net/v3/sprints/44**",
  "id" : 44**,
  "version" : 1435288720018,
  "name" : "sprint1",
  "board" : {
    "self": "https://api.tracker.yandex.net/v3/boards/3",
    "id" : "3",
    "display" : "Testing"
  },
  "status" : "in_progress",
  "archived" : false,
  "createdBy" : {
    "self": "https://api.tracker.yandex.net/v3/users/33********",
    "id" : "33********",
    "display" : "Viktor Buldakov"
  },
  "createdAt" : "2015-06-23T17:03:24.799+0000",
  "startDate" : "2015-06-01",
  "endDate" : "2015-06-14",
  "startDateTime": "2015-06-01T07:00:00.000+0000",
  "endDateTime": "2015-06-14T07:00:00.000+0000"
  },
   ...
]
Response parameters
Parameter Description Data type
self Address of the API resource with sprint parameters. String
id Sprint ID. Number
version Sprint version. Each change to the sprint increases its version number. Number
name Sprint name. String
board Object with information about the board whose issues the sprint refers to. String
status Sprint status.
The following statuses are possible:
  • draft: Open.
  • in_progress: In progress.
  • released: Resolved.
  • archived: Archived.
String
archived Shows whether the sprint is archived:
  • true: The sprint is archived.
  • false: The sprint is not archived.
Boolean
createdBy Object with information about the user who created the sprint. Map item
createdAt Sprint creation date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
startDate Sprint start date in YYYY-MM-DD format String
endDate Sprint end date in YYYY-MM-DD format String
startDateTime Date and time of the sprint's actual start in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
endDateTime Date and time of the sprint's actual end in YYYY-MM-DDThh:mm:ss.sss±hhmm format String

board object fields

Parameter Description Data type
self Address of the API resource with information about the board. String
id Board ID String
display Board name displayed. String

createdBy object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String

If the request is processed incorrectly, the API returns a message with error details:

400
One or more request parameters have an invalid value.
403
You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
The requested object was not found. You may have specified an invalid object ID or key.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.