Skip to content

Risk API

Retrieve risk registers and risks from Kendis, including computed risk levels, type-aware custom fields, and the boards linked to a register.

  • Method: Versioned subdomain — https://{yourcompany}.kendis.io/api/v1/… (details)
  • Auth: HTTP Basic — email : API key
  • Envelope: { "startAt", "pageLimit", "total", "data": [ … ] }
  • Pagination: startAt / pageLimit query params (max 50)

Quick reference

Action Method Path
List risk registers GET /api/v1/riskregister
List risks for a register GET /api/v1/{registerIdOrKey}/risk
Get a single risk GET /api/v1/risk/{riskId}
Get register for a board GET /api/v1/{boardId}/riskregister
Get boards for a register GET /api/v1/{registerIdOrKey}/boards

All URLs: https://{yourcompany}.kendis.io + the path above.

Concepts

  • A risk register groups related risks and defines a risk matrix (the impact × probability bands).
  • Each risk carries impact, probability, a computed riskLevel, linked board items, teams, sprints, and any user-defined custom fields.
  • A register can be linked to one or more boards (PI Board, Solution Train, Portfolio board, etc.).
graph LR
  A[GET /riskregister] --> B[GET /{register}/risk]
  B --> C[GET /risk/{riskId}]
  A --> D[GET /{register}/boards]

Trim payloads with ?fields=

Every endpoint supports field selection — ?fields=all for the full object, or a comma-separated list to reduce payload size on bulk BI exports. See Field selection.