Reading Your Board Through the Ticket API
The Ticket API has always been about pushing things into WarmDesk: a CI pipeline creates a card when a build fails, comments when it’s fixed, and moves it to Done on deploy. What it couldn’t do was tell you what’s already there.
That gap showed up in a very practical way. An automation agent was asked to "read the Backlog lane, report which tasks are open and how much work that is, and don’t change anything". It had a project-scoped API key and three documented endpoints: create, comment, move. Every one of them writes. The only way to "look" would have been to create a probe card, which is exactly what it had been told not to do.
v0.29.0 fixes that.
Three new read endpoints
| Method | Path | Returns |
|---|---|---|
|
| The project’s lanes, left to right, with their ids |
|
| Cards, optionally filtered to one lane |
|
| One card, with its comments |
They use the same X-API-Key header as the existing endpoints, project-scoped keys included, and need only viewer access to the project. None of them change anything.
Reading one lane
Filter by lane name (case-insensitive) or by id:
curl -s -H "X-API-Key: $WARMDESK_KEY" \
"https://warmdesk.example.com/api/v1/ticket/ansible-fundamentals/cards?column=Backlog" \
| jq '.[] | {key, title, priority, story_points}'Only open cards are returned unless you add include_closed=true. Each card carries its lane name (column_name) and its human-readable key (ANSI-12), plus everything you need to size the work: priority, story points, time spent, due date, labels, tags, assignees, and epic.
Where to find it
The endpoints are listed in Project Settings → API Keys, next to the existing ones, and documented in the API reference. The Bruno and Postman collections include them too.