Projects

Read a project spec

Returns the project's spec tree limited to the requested altitude: high renders the goal, medium adds phases, low adds items joined with their mirrored tracker issues. Defaults to high.

get/api/v1/projects/{projectId}/spec

Request

  • Base URL
    https://app.khotan.com
  • URL
    https://app.khotan.com/api/v1/projects/{projectId}/spec
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

projectIdstring required

Query parameters

altitude'high' | 'medium' | 'low'

Depth cap over the one spec tree: high renders the goal, medium adds phases, low adds items and their mirrored tracker issues.

Response

The rendered spec.

projectIdstring required
altitudestring required
revisionnumber required
rootSchema0 required(unresolved $ref)
issuesByPhaseIdobject required

Changes

No recorded changes to this operation across all 1 revision of this API.