Skip to content

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 / pageSize in 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]
  1. List collections to get collection IDs (workspaces).
  2. List boards (optionally filtered by collection) to get the boardId.
  3. POST to /items with that boardId to retrieve Features and their child Stories.
  4. The items response references sprints, teams, and statuses by ID — call /sprints, /teams, and /statuses to 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.