Skip to main content
GET
Read the workflow definition

Authorizations

Authorization
string
header
required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Query Parameters

branchId
string
required
Required string length: 1 - 200
projectId
string
required
Required string length: 1 - 200

Response

Read the workflow definition

definition
object | null
required

Ids are unique within roles, stages, transitions and gates; a stage's requiredRole names a declared role; only consensus-read stages declare readers, and they must; only auto-label stages run by a runner declare runner; every transition names declared stages; a sampling gate below the full rate only enters a stage that judges work (adjudicate, consensus-read or review).

workflowVersion
string | null
required