Skip to main content

The credential

endpoint
What this credential is and which boards it reaches, by id. The one call that never asks you to choose one, and where the ids for the X-Tylon-Workspace header come from — see Choosing a board.

Projects

endpoint
The products inside a board. A board’s columns belong to a project, so this is what you read to find the projectId the other calls want.

The board

endpoint
Every stage of the flow with the cards standing in it, in order.
string
Which product. Optional when the board has one; 400 when it has several.
The columns are the flow’s stages, and each one is a real branch rule — which is why a card sitting in a column is a statement about the repository rather than a status somebody typed.
minRole on a column is what it takes to move a card into it, and statusId is what a move is addressed by — the two things a script needs before it can promote anything.
blocked on a card means its last promotion was refused — the branch had conflicts, the checks were red, there was nothing to merge. The reason is on the card itself.

The backlog

endpoint
Drafts: a title, a description, a discussion, and no Git at all. Nothing here has a branch, because starting a card is the deliberate act that cuts one.
string
Same rule as the board.
Answers with an array of cards in the same shape /v1/cards/{number} uses.