Engines

Strategic engines summary

GET /api/v1/engines/summary

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/engines/summary?organisationId=<organisationId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

Goal outcomes

GET /api/v1/engines/goals

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—
`limit`	query	integer	No	—
`cursor`	query	string	No	Opaque continuation token from a previous list response's `nextCursor`.

Example request

curl -X GET \
"https://api.example.com/api/v1/engines/goals?organisationId=<organisationId>&limit=<limit>&cursor=<cursor>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [],
  "nextCursor": "string"
}

Response body type

{ data: array; nextCursor: string }

Value goals

GET /api/v1/engines/values

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—
`limit`	query	integer	No	—
`cursor`	query	string	No	Opaque continuation token from a previous list response's `nextCursor`.

Example request

curl -X GET \
"https://api.example.com/api/v1/engines/values?organisationId=<organisationId>&limit=<limit>&cursor=<cursor>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [],
  "nextCursor": "string"
}

Response body type

{ data: array; nextCursor: string }

Principles

GET /api/v1/engines/principles

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—
`limit`	query	integer	No	—
`cursor`	query	string	No	Opaque continuation token from a previous list response's `nextCursor`.

Example request

curl -X GET \
"https://api.example.com/api/v1/engines/principles?organisationId=<organisationId>&limit=<limit>&cursor=<cursor>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [],
  "nextCursor": "string"
}

Response body type

{ data: array; nextCursor: string }

Pillars

GET /api/v1/engines/pillars

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—
`limit`	query	integer	No	—
`cursor`	query	string	No	Opaque continuation token from a previous list response's `nextCursor`.
`status`	query	—	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/engines/pillars?organisationId=<organisationId>&limit=<limit>&cursor=<cursor>&status=<status>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [],
  "nextCursor": "string"
}

Response body type

{ data: array; nextCursor: string }

Risk / off-track items

GET /api/v1/engines/risks

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/engines/risks?organisationId=<organisationId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

Strategic + operational bundle

GET /api/v1/engines/context

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/engines/context?organisationId=<organisationId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—