Skip to main content
GET
Get the Architect's decisions ledger
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/getArchitectDecisions Returns the resolved decisions of the draft’s active Architect conversation: plans that were confirmed, edited, rejected or expired, and synthesis batches that were confirmed in whole or part, rejected, sent back or expired. Pending ones are read with getArchitectPlan and getSynthesisConfirmation. Nothing is written.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:read, held at the workflow’s home org unit. The org unit a request acts from is not the workflow’s home.

Query parameters

string
required
The workflow ID. Give it exactly once.

Responses

string
The workflow ID.
string
The draft’s ID.
object[]
Newest first. A plan entry has id, status, stepCount, summary and resolvedAt; a synthesis entry has id, status, itemCount, confirmedCount, itemNames and resolvedAt. Empty when the draft has no active Architect conversation.
boolean
true when the conversation holds more than 200 plans or 200 batches; only the newest 200 of each are read.
Who resolved each decision is not returned.

Errors

Example

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

workflowId
string
required

Workflow document id. Give it exactly once.

Minimum string length: 1

Response

Get the Architect's decisions ledger

data
object
required
meta
object
required