Filtering by Releases, Iterations and Team Iterations

Current Release, Iteration or Team Iteration

Current Release, Iteration or Team Iterations has its Start Date in the past and End Date in the future. To pull the items which belong to the current Release, Iteration or Team Iteration you need to use boolean IsCurrent field:

/api/v2/userstories?where=(Release.IsCurrent=true)
/api/v2/bugs?where=(Release.IsCurrent=true)
/api/v2/features?where=(Release.IsCurrent=true)
/api/v2/assignables?where=(Release.IsCurrent=true)

/api/v2/userstories?where=(Iteration.IsCurrent=true)
/api/v2/bugs?where=(Iteration.IsCurrent=true)
/api/v2/assignables?where=(Iteration.IsCurrent=true)

/api/v2/userstories?where=(TeamIteration.IsCurrent=true)
/api/v2/bugs?where=(TeamIteration.IsCurrent=true)
/api/v2/assignables?where=(TeamIteration.IsCurrent=true)

Past Releases, Iterations or Team Iterations

Past Release, Iteration or Team Iterations has both its Start Date and End Date in the past. To pull items which belong to past Releases, Iterations or Team Iterations you need to use boolean IsPrevious field:

/api/v2/userstories?where=(Release.IsPrevious=true)
/api/v2/bugs?where=(Release.IsPrevious=true)
/api/v2/features?where=(Release.IsPrevious=true)
/api/v2/assignables?where=(Release.IsPrevious=true)

/api/v2/userstories?where=(Iteration.IsPrevious=true)
/api/v2/bugs?where=(Iteration.IsPrevious=true)
/api/v2/assignables?where=(Iteration.IsPrevious=true)

/api/v2/userstories?where=(TeamIteration.IsPrevious=true)
/api/v2/bugs?where=(TeamIteration.IsPrevious=true)
/api/v2/assignables?where=(TeamIteration.IsPrevious=true)

If you're not interested in all the old items and you'd only like to pull one or several latest Releases, Iterations or Team Iterations, you need to use InPast(x) function, where x is the amount of latest Releases, Iterations or Team Iterations you will get in response:

/api/v2/userstories?where=(Release.InPast(1))
/api/v2/bugs?where=(Release.InPast(2))
/api/v2/features?where=(Release.InPast(1))
/api/v2/assignables?where=(Release.InPast(3))

/api/v2/userstories?where=(Iteration.InPast(1))
/api/v2/bugs?where=(Iteration.InPast(2))
/api/v2/assignables?where=(Iteration.InPast(1))

/api/v2/userstories?where=(TeamIteration.InPast(1))
/api/v2/bugs?where=(TeamIteration.InPast(2))
/api/v2/assignables?where=(TeamIteration.InPast(1))

📘
If Releases, Iterations or Team Iterations belong to different Projects, InPast(x) function will return x Releases, Iterations or Team Iterations for each Project.

Future Releases, Iterations or Team Iterations

Future Release, Iteration or Team Iterations has both its Start Date and End Date in the future. To pull items which belong to future Releases, Iterations or Team Iterations you need to use boolean IsNext field:

/api/v2/userstories?where=(Release.IsNext=true)
/api/v2/bugs?where=(Release.IsNext=true)
/api/v2/features?where=(Release.IsNext=true)
/api/v2/assignables?where=(Release.IsNext=true)

/api/v2/userstories?where=(Iteration.IsNext=true)
/api/v2/bugs?where=(Iteration.IsNext=true)
/api/v2/assignables?where=(Iteration.IsNext=true)

/api/v2/userstories?where=(TeamIteration.IsNext=true)
/api/v2/bugs?where=(TeamIteration.IsNext=true)
/api/v2/assignables?where=(TeamIteration.IsNext=true)

If you're not interested in all the future items and you'd only like to pull one or several nearest Releases, Iterations or Team Iterations, you need to use InFuture(x) function, where x is the amount of upcoming Releases, Iterations or Team Iterations you will get in response:

/api/v2/userstories?where=(Release.InFuture(1))
/api/v2/bugs?where=(Release.InFuture(2))
/api/v2/features?where=(Release.InFuture(1))
/api/v2/assignables?where=(Release.InFuture(3))

/api/v2/userstories?where=(Iteration.InFuture(1))
/api/v2/bugs?where=(Iteration.InFuture(2))
/api/v2/assignables?where=(Iteration.InFuture(1))

/api/v2/userstories?where=(TeamIteration.InFuture(1))
/api/v2/bugs?where=(TeamIteration.InFuture(2))
/api/v2/assignables?where=(TeamIteration.InFuture(1))

📘
If Releases, Iterations or Team Iterations belong to different Projects, InFuture(x) function will return x Releases, Iterations or Team Iterations for each Project.