Creates a future sprint. Sprint name and origin board id are required. Start and end date are optional. Notes: The sprint name is trimmed. Only Jira administrators can create synced sprints.
The sprint to create.
boolean
string
string
integer
string
integer
string
boolean
string
Returns the created sprint.
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/agile/1.0/sprint' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Sets the Synced flag to false for all sprints in the provided list.
The sprints to unmap.
array<integer>
Empty response is returned if operation was successful.
1
2
3
4
curl --request PUT \
--url 'http://{baseurl}/rest/agile/1.0/sprint/unmap' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json'Sets the Synced flag to false for all sprints on this Jira instance. This operation is intended for cleanup only. It is highly destructive and not reversible. Use with caution.
This request has no parameters.
Empty response is returned if operation was successful.
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/agile/1.0/sprint/unmap-all' \
--user 'email@example.com:<api_token>'Returns a single sprint, for a given sprint Id. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint.
integer
RequiredReturns the requested sprint.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Performs a full update of a sprint. A full update means that the result will be exactly the same as the request body. Any fields not present in the request JSON will be set to null. Notes:
integer
RequiredThe updated sprint.
string
boolean
string
string
string
integer
integer
string
integer
string
Returns the updated sprint.
1
2
3
4
5
curl --request PUT \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated. Notes:
integer
RequiredThe updated sprint.
string
boolean
string
string
string
integer
integer
string
integer
string
Returns the updated sprint.
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Deletes a sprint. Once a sprint is deleted, all issues in the sprint will be moved to the backlog. To delete a synced sprint, you must unsync it first.
integer
RequiredReturned if the sprint was deleted successfully.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}' \
--user 'email@example.com:<api_token>'Returns all issues in a sprint, for a given sprint Id. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank.
integer
Requiredstring
string
integer
boolean
array<StringList>
integer
Returns the requested issues, at the specified page of the results.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}/issue' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Moves issues to a sprint, for a given sprint Id. Issues can only be moved to open or active sprints. The maximum number of issues that can be moved in one operation is 50.
integer
RequiredThe issues to move.
array<string>
Empty response is returned if operation was successful.
1
2
3
4
curl --request POST \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}/issue' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json'Returns the keys of all properties for the sprint identified by the id. The user who retrieves the property keys is required to have permissions to view the sprint.
string
RequiredReturns the requested property keys.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}/properties' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Returns the value of the property with a given key from the sprint identified by the provided id. The user who retrieves the property is required to have permissions to view the sprint.
string
Requiredstring
RequiredReturns the requested property.
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Sets the value of the specified sprint's property. You can use this resource to store a custom data against the sprint identified by the id. The user who stores the data is required to have permissions to modify the sprint.
string
Requiredstring
RequiredReturned if the sprint property is successfully updated.
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}' \
--user 'email@example.com:<api_token>'Removes the property from the sprint identified by the id. Ths user removing the property is required to have permissions to modify the sprint.
string
Requiredstring
RequiredReturned if the sprint property was removed successfully.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}' \
--user 'email@example.com:<api_token>'Swap the position of the sprint with the second sprint.
integer
RequiredThe sprint to swap with.
integer
integer
Returned if the sprint swap was performed successfully.
1
2
3
4
curl --request POST \
--url 'http://{baseurl}/rest/agile/1.0/sprint/{sprintId}/swap' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json'Rate this page: