Skip to content

Milestones & Phases API

Retrieve the milestones and phases of a PI Board, their completion, and the board cards they track.

A milestone marks a single date (for example a release go-live); a phase spans a period from startDate to endDate (for example user acceptance testing). Both are measured the same way: each reports all three completion methods the board offers, and completionPct follows the method selected for it.

  • Method: Versioned subdomain · https://{yourcompany}.kendis.io/api/v1/… (details)
  • Auth: HTTP Basic · email : API key
  • Envelope: { "startAt", "pageLimit", "total", "Data": [ … ] } (capital Data)
  • Pagination: startAt / pageLimit query params (max 50)
  • Lookup: {keyOrId} accepts the milestone or phase key (e.g. M-21, P-7) or its internal ID

Quick reference

Step Action Method Path
1 List boards (gets boardId) GET /api/v1/boards
2 Milestones and phases of a board GET /api/v1/pi-boards/{boardId}/milestones[?type=all\|milestones\|phases]
3 One milestone or phase GET /api/v1/pi-boards/{boardId}/milestones/{keyOrId}
4 Cards linked to it GET /api/v1/pi-boards/{boardId}/milestones/{keyOrId}/linked-items[?expand=children]

All URLs: https://{yourcompany}.kendis.io + the path above. See Endpoints for examples.

graph TD
  B[PI Board] --> M[Milestone · date]
  B --> P[Phase · startDate to endDate]
  M --> C1[Linked cards]
  P --> C2[Linked cards]
  C1 --> S1[Sub-items]
  C2 --> S2[Sub-items]

Access rules

A board's milestones and phases are served only when the board belongs to your company, is not deleted, and its collection is one the API user can open in Kendis. Otherwise the response is 404 with the same message, whether the board does not exist or is not visible to you. A milestone or phase key that is not linked to the board is also a 404.

Milestone and phase routes work on every board you can access, including boards whose Objectives screen has never been used. Boards whose objectives live in the legacy objectives view return 400.

Completion

Every milestone and phase returns all three completion methods side by side in completion:

Method Calculation
By linked item status Linked cards in a Done status / all linked cards
By children status Sub-items in a Done status / all sub-items of the linked cards
By children estimate Story points of Done sub-items / story points of all sub-items

completionPct is the value of the method selected for that milestone or phase (named in criteria). See Milestone completion for the rules and a worked example.

  • PI Objectives: objective groups, objectives, key results and their cards on the same PI boards.
  • PI Board Items: all features and stories on a board.