Dashboard¶

Kanban boards (Kanban / Dashboard) are used to organize work items at the organization level. With the API, you can query an organization's board list and details and the list of items within a board, add an Issue or Pull Request to a board, modify its board state, or remove it from a board.

Boards belong to an organization. In the path, {owner} refers to the organization path.

Objects¶

Identification¶

• An organization is identified by {owner}, and a board by kanban_id.
• A work item is located by {type} (such as issue or pull request) + {iid}; there is also a repository-scoped path repo/{repo}.

Common tasks¶

Notes¶

• The path uses the singular org: /api/v5/org/{owner}/kanban/…, which differs from the organization member endpoints' /orgs/{org}/….
• Here {owner} refers to the organization path, not the repository owner; boards are organization-level resources.
• The endpoint that updates the board associated with a work item has a different path structure: …/kanban/repo/{repo}/{type}/{iid}, without kanban_id.
• Adding to a board and modifying the state are two separate actions: add_item creates the association, and state changes the column / state; do not expect a single call to do both.
• Writing board field values to an Issue uses the Issue group's kanban_values endpoint; this group only handles the board-side association and state.

Endpoint list¶

This module contains 7 endpoints.