Contact UsGet started

Creating a sprint

Written by
Updated at February 19, 2024

Use this request to create sprints.

Request format

To create a sprint, use an HTTP POST request:

POST /v2/sprints
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
  "name": "New Sprint",
  "board":
    {
      "id": "1"
    },
  "startDate": "2018-10-21",
  "endDate": "2018-10-24"
}
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Request body parameters

Required parameters

Parameter Description Data type
name Sprint name. String
board Object with information about the board whose issues the sprint refers to. String
startDate Sprint start date in YYYY-MM-DD format String
endDate Sprint end date in YYYY-MM-DD format String

board object fields

Parameter Description Data type
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 object with the parameters of the created sprint.

{
  "self" : "https://https://api.tracker.yandex.net/v2/sprints/44**",
  "id" : 44**,
  "version" : 1,
  "name" : "New Sprint",
  "board" : {
    "self" : "https://https://api.tracker.yandex.net/v2/boards/3",
    "id" : "1",
    "display" : "Testing"
  },
  "status" : "draft",
  "archived" : false,
  "createdBy" : {
    "self" : "https://https://api.tracker.yandex.net/v2/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.
 Logical
createdBy Object with information about the user who created the sprint. Object
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
Insufficient rights 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.
422
JSON validation error, the request is rejected.
500
Internal service error. Try resending your request in a few minutes.
503
The API service is temporarily unavailable.
Previous
Getting a sprint
Next
Getting a list of components