Cards

List cards in the backlog

GET /api/boards/:board/backlog

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

Gets a summary of all the cards in the backlog, listed in order of priority.

Cards that have been moved to an iteration and later moved back to the backlog will have been assigned a column (e.g. 'To Do') when they were in the iteration. The column is remembered, and will be shown in this call where applicable.

More information on each card is available on a card's own URL.

{
  "backlog": {
    "url": "https://www.agileplannerapp.com/api/boards/138992/backlog",
    "board_url": "https://www.agileplannerapp.com/api/boards/138992",
    "cards": [
      {
        "url": "https://www.agileplannerapp.com/api/boards/138992/cards/1",
        "activity_url": "https://www.agileplannerapp.com/api/boards/138992/cards/1/activity",
        "number": 1,
        "title": "Click 'Current Iteration' (above) to start work",
        "estimate": "4",
        "stickers": [
          {
            "label": "Green",
            "color": "green"
          }
        ]
      },
      {
        "url": "https://www.agileplannerapp.com/api/boards/138992/cards/2",
        "activity_url": "https://www.agileplannerapp.com/api/boards/138992/cards/2/activity",
        "number": 2,
        "title": "Or try dragging one up into the current iteration...",
        "estimate": "3",
        "stickers": [

        ]
      },
      {
        "url": "https://www.agileplannerapp.com/api/boards/138992/cards/3",
        "activity_url": "https://www.agileplannerapp.com/api/boards/138992/cards/3/activity",
        "number": 3,
        "title": "Click a card's title to open it",
        "estimate": "2",
        "stickers": [

        ]
      },
      {
        "url": "https://www.agileplannerapp.com/api/boards/138992/cards/4",
        "activity_url": "https://www.agileplannerapp.com/api/boards/138992/cards/4/activity",
        "number": 4,
        "title": "The backlog is where your unscheduled cards live",
        "estimate": "1",
        "stickers": [

        ]
      }
    ]
  }
}

Get a card

GET /api/boards/:board/cards/:card

The value of :board should be set to the number of a board that the authenticated user has access to, while :card should match the number of one of the cards on this board.

Gets all the title, estimate, story text and notes for a card, along with URLs for extra metadata (such as activity).

{
  "card": {
    "url": "https://www.agileplannerapp.com/api/boards/138992/cards/2",
    "activity_url": "https://www.agileplannerapp.com/api/boards/138992/cards/2/activity",
    "number": 2,
    "title": "Or try dragging one up into the current iteration...",
    "estimate": "3",
    "stickers": [

    ],
    "story": {
      "markdown": null,
      "html": "",
      "last_updated_at": 1402414062.7587311
    },
    "notes": {
      "markdown": null,
      "html": "",
      "last_updated_at": 1402414062.7587311
    },
    "board_url": "https://www.agileplannerapp.com/api/boards/138992",
    "iteration": null
  }
}

Get history of a card's activity

GET /api/boards/:board/cards/:card/activity

Lists the significant changes that have been made to a card. Each event object contains a brief description of the event, a timestamp recording when the event occurred, and some metadata about the user who created it (though system generated events don't contain any user details).

{
  "activity": {
    "card_url": "https://www.agileplannerapp.com/api/boards/138992/cards/2/activity",
    "events": [
      {
        "description": "Card was created",
        "created_at": "Tue, 10 Jun 2014 15:27:42 +0000",
        "user": {
        }
      }
    ]
  }
}