Iterations - List
Get a team's iterations using timeframe filter
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations?api-version=6.0
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations?$timeframe={$timeframe}&api-version=6.0
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path | True |
string |
Project ID or project name |
team
|
path |
string |
Team ID or team name |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '6.0' to use this version of the api. |
$timeframe
|
query |
string |
A filter for which iterations are returned based on relative time. Only Current is supported currently. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Name | Description |
---|---|
vso.work | Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks. |
Examples
Get a team's iterations using timeframe filter
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/iterations?$timeframe=current&api-version=6.0
Sample Response
{
"values": [
{
"id": "a589a806-bf11-4d4f-a031-c19813331553",
"name": "Sprint 2",
"attributes": {
"startDate": null,
"finishDate": null
},
"url": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553"
}
]
}
Definitions
Name | Description |
---|---|
Reference |
The class to represent a collection of REST reference links. |
Team |
|
Team |
Represents a shallow ref for a single iteration. |
Time |
Time frame of the iteration, such as past, current or future. |
ReferenceLinks
The class to represent a collection of REST reference links.
Name | Type | Description |
---|---|---|
links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
TeamIterationAttributes
Name | Type | Description |
---|---|---|
finishDate |
string |
Finish date of the iteration. Date-only, correct unadjusted at midnight in UTC. |
startDate |
string |
Start date of the iteration. Date-only, correct unadjusted at midnight in UTC. |
timeFrame |
Time frame of the iteration, such as past, current or future. |
TeamSettingsIteration
Represents a shallow ref for a single iteration.
Name | Type | Description |
---|---|---|
_links |
Collection of links relevant to resource |
|
attributes |
Attributes of the iteration such as start and end date. |
|
id |
string |
Id of the iteration. |
name |
string |
Name of the iteration. |
path |
string |
Relative path of the iteration. |
url |
string |
Full http link to the resource |
TimeFrame
Time frame of the iteration, such as past, current or future.
Name | Type | Description |
---|---|---|
current |
string |
|
future |
string |
|
past |
string |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for