PI Board Items API¶
Retrieve the items — Features (parents) and Stories (children) — on a Kendis Program Board, plus the board's sprint, team, and status metadata.
- Method: Legacy path-prefix —
https://rest.kendis.io/api/<companyPrefix>/…(details) - Auth: HTTP Basic —
email:API key(details) - Envelope:
{ "data": [ … ] } - Pagination:
pageStart/pageSizein the POST body
Quick reference¶
| Action | Method | Path |
|---|---|---|
| List collections | GET |
/api/<companyPrefix>/collections |
| List boards | GET |
/api/<companyPrefix>/boards |
| List board items | POST |
/api/<companyPrefix>/items |
| Sprint metadata | POST |
/api/<companyPrefix>/sprints |
| Team metadata | POST |
/api/<companyPrefix>/teams |
| Status metadata | POST |
/api/<companyPrefix>/statuses |
All URLs: https://rest.kendis.io + the path above.
Typical flow¶
graph LR
A[GET /collections] --> B[GET /boards?collectionId=…]
B --> C[POST /items with boardId]
C --> D[POST /sprints · /teams · /statuses<br/>to resolve IDs]
- List collections to get collection IDs (workspaces).
- List boards (optionally filtered by collection) to get the
boardId. - POST to
/itemswith thatboardIdto retrieve Features and their child Stories. - The items response references sprints, teams, and statuses by ID — call
/sprints,/teams, and/statusesto resolve those IDs to titles/labels/colours.
Next steps
See the Endpoints page for full request/response examples, and the Field reference for every parent and child item property.