GoRunner

Get one workflow

Requires scope workflow:read
GET
/api/workflows/{id}

Returns a single workflow, scoped to the token's workspace — a workflow in another workspace is a 404, never a 403.

definition here is the DRAFT: what the editor holds, not necessarily what production runs. hasUnpublishedChanges (computed only on this route) tells you the draft has moved ahead of the published version. definitionRev is the optimistic-lock revision — capture it here and send it back as expectedRev on PUT /api/workflows/{id} to avoid clobbering a concurrent writer.

webhookToken is returned ONLY to a caller holding workflow:run; with workflow:read alone the field is stripped, because the token is a bearer capability against an endpoint that is unauthenticated by design — holding it IS the ability to fire the flow in production.

Authorization

bearerAuth
AuthorizationBearer <token>

An API token: Authorization: Bearer grt_…. Mint one in the app under Settings → Workspace → API tokens; the raw value is shown once. Scopes confine the token — see x-permission on each operation.

In: header

Path Parameters

id*string

Workflow id. A value that is not a UUID is a 400, not a 404.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "definition": {      "schemaVersion": 2,      "trigger": {        "name": "string",        "displayName": "string",        "type": "manual",        "pieceId": "string",        "pieceVersion": "string",        "actionId": "string",        "config": {},        "connectionId": "string",        "valid": true,        "nextAction": {          "name": "string",          "displayName": "string",          "type": "PIECE",          "pieceId": "string",          "pieceVersion": "string",          "actionId": "string",          "config": {},          "connectionId": "string",          "valid": true,          "skip": true,          "nextAction": {},          "branches": [            {              "name": "string",              "conditions": [                [                  {                    "field": "string",                    "operator": "text_eq",                    "value": null                  }                ]              ],              "firstAction": {}            }          ],          "firstLoopAction": {},          "onErrorAction": {}        }      },      "settings": {        "timeoutSeconds": 0,        "errorWorkflowId": "51d8ee47-3646-4ae6-bc48-c85415c9166a",        "concurrencyLimit": 0,        "maintenanceMode": true,        "autoPublishFixes": true      },      "annotations": null,      "variables": {},      "pinnedData": {}    },    "status": "draft",    "triggerType": "manual",    "cronExpression": "string",    "webhookToken": "string",    "latestVersionId": "750445c5-7ad9-40bd-a593-bb37d7d846db",    "definitionRev": 0,    "hasUnpublishedChanges": true,    "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",    "tags": [      "string"    ],    "testPayloads": {},    "pinnedData": {},    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",    "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "lastRun": {      "status": "pending",      "startedAt": "2019-08-24T14:15:22Z"    }  }}