NUnullplatform
Workflow definitions

Read a workflow

Changed on

Returns the workflow and one resolved revision: the latest by default, or the one selected with revision or alias (mutually exclusive).

get/workflows/definitions/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/definitions/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Workflow reference: a server-minted id (wf_...) or the workflow's client-chosen key (lowercase slug, unique per organization).

Query parameters

revisioninteger

Return this revision number.

aliasstring

Return the revision this alias points at.

Response

The workflow and the resolved revision.

resolvedVia'latest' | 'alias' | 'revision'
aliasNamestring

Present when resolved via alias.

Example response

{
  "workflow": {
    "id": "wf_ifWBbWfpug0n",
    "key": "ami-drift-scanner",
    "name": "AMI drift scanner",
    "path": "/action-items/ami-drift"
  },
  "revision": {
    "workflowId": "wf_ifWBbWfpug0n",
    "revision": 3
  }
}

Changes