Iterations

Get an iteration

GET /api/boards/:board/iterations/:iteration

Gets an iteration, and a summary of all the cards within it.

The value of :board should be set to the number of a board that the authenticated user has access to.

The value of :iteration can be set to either current if you'd like to retrieve the current iteration, or a string representing the date on which an iteration started, formatted YYYYMMDD (four digits for the year, two for the month and two for the day of the month).

The iteration's cards are summarised, listed in order of priority (the first card in the list being the highest priority).

Cards that are assigned to a column contain a property for the column's name.

The full list of columns that are in use in this iteration are listed in order.

{
  "iteration": {
    "url": "https://www.agileplannerapp.com/api/boards/138992/iterations/20140527",
    "begins_on": "Tue, 27 May 2014 00:00:00 +0000",
    "ends_on": "Mon, 9 Jun 2014 00:00:00 +0000",
    "board_url": "https://www.agileplannerapp.com/api/boards/138992",
    "cards": [
      {
        "url": "https://www.agileplannerapp.com/api/boards/138992/cards/6",
        "activity_url": "https://www.agileplannerapp.com/api/boards/138992/cards/6/activity",
        "number": 6,
        "title": "List the cards in an iteration",
        "estimate": "2",
        "column": "Released",
        "stickers": [

        ]
      },
      {
        "url": "https://www.agileplannerapp.com/api/boards/138992/cards/7",
        "activity_url": "https://www.agileplannerapp.com/api/boards/138992/cards/7/activity",
        "number": 7,
        "title": "Re-prioritise the cards in an iteration",
        "estimate": "1",
        "column": "Done",
        "stickers": [

        ]
      }
    ],
    "columns": [
      "To Do",
      "In Progress",
      "Done",
      "Released"
    ]
  }
}