API
Boards and sprints
Boards, backlogs, sprint planning, sprint reports and velocity.
See Tasks.
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
GET /v1/orgs/:orgId/issues/boards | Boards the caller can see (space narrows to boards showing that space). |
POST /v1/orgs/:orgId/issues/boards | Creates a board over one or more spaces, with columns from their workflows' statuses. |
GET /v1/orgs/:orgId/issues/boards/:boardId | A board's configuration. |
PATCH /v1/orgs/:orgId/issues/boards/:boardId | Changes a board's name, columns (status mapping, WIP limits), swimlanes, quick filters, card fields and sharing. |
DELETE /v1/orgs/:orgId/issues/boards/:boardId | Deletes a board without an active sprint; issues in its future sprints return to the backlog. |
GET /v1/orgs/:orgId/issues/boards/:boardId/issues | The board's cards: the active sprints' issues (scrum) or the flow (kanban), with quick filters (comma-separated ids). |
GET /v1/orgs/:orgId/issues/boards/:boardId/backlog | Active and future sprints with their issues, the backlog and the epics of the board's spaces. |
POST /v1/orgs/:orgId/issues/boards/:boardId/move | Moves a card to a column (through the workflow) and optionally ranks it next to another card. 409 names the fields a transition asks for. |
GET /v1/orgs/:orgId/issues/boards/:boardId/velocity | Committed and completed estimates of the last closed sprints. |
GET /v1/orgs/:orgId/issues/sprints | Sprints of the boards the caller can see: active first, then future, then closed (newest first). |
POST /v1/orgs/:orgId/issues/sprints | Creates a future sprint on a scrum board. |
POST /v1/orgs/:orgId/issues/sprints/move | Puts issues into a sprint (sprint: null for the backlog), optionally ranked before or after another issue. |
PATCH /v1/orgs/:orgId/issues/sprints/:sprintId | Changes a sprint's name, goal, dates, order or capacity. |
POST /v1/orgs/:orgId/issues/sprints/:sprintId/start | Starts a future sprint; its issues become the committed scope. |
POST /v1/orgs/:orgId/issues/sprints/:sprintId/complete | Completes an active sprint; open issues move to moveTo (a sprint id, new or backlog). |
GET /v1/orgs/:orgId/issues/sprints/:sprintId/report | Burndown, scope changes and outcome of a sprint. |
DELETE /v1/orgs/:orgId/issues/sprints/:sprintId | Deletes a future sprint; its issues return to the backlog. |