Skip to main content
GET
Get a roadmap
Returns one PlanningRoadmap. A missing, repeated or unknown id is 404 resource_missing. The credential needs the objectives:read scope and objectives:read granted at the deployment root; otherwise 403 permission_denied names the missing permission.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

roadmapId
string
required

Response

Get a roadmap

data
object
required
meta
object
required