LoginGet started

Workflow

A workflow run represents an execution instance of a workflow. It contains the execution history, status, and any errors that occurred during the run.

List workflows

get

Returns a list of workflows for the organisation, ordered by creation date with the most recent first.

Authorizations
Query parameters
pageintegerOptional

The collection page number

Default: 1
Responses
200

Workflow collection

get
GET /workflows HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "createdAt": "2025-08-20T03:44:53.834Z",
    "updatedAt": "2025-08-20T03:44:53.834Z",
    "name": "text",
    "description": null,
    "status": "Draft",
    "startingTriggerType": "customer_created"
  }
]

Retrieve a workflow

get

Retrieve details of a specific workflow by its ID.

Authorizations
Path parameters
idstringRequired

Workflow identifier

Responses
200

Workflow resource

get
GET /workflows/{id} HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "createdAt": "2025-08-20T03:44:53.834Z",
  "updatedAt": "2025-08-20T03:44:53.834Z",
  "name": "text",
  "description": null,
  "status": "Draft",
  "startingTriggerType": "customer_created"
}

Delete a workflow

delete

Delete a workflow and all its associated data. This action cannot be undone.

Authorizations
Path parameters
idstringRequired

Workflow identifier

Responses
204

Workflow resource deleted

delete
DELETE /workflows/{id} HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

No content

List workflow runs for a specific workflow

get

Returns a list of workflow run executions for a specific workflow, ordered by creation date with the most recent first.

Authorizations
Path parameters
workflowIdstringRequired

WorkflowRun identifier

Query parameters
pageintegerOptional

The collection page number

Default: 1
Responses
200

WorkflowRun collection

get
GET /workflows/{workflowId}/runs HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "createdAt": "2025-08-20T03:44:53.834Z",
    "updatedAt": "2025-08-20T03:44:53.834Z",
    "completedAt": null,
    "status": "running",
    "context": [
      "text"
    ],
    "executedNodes": [
      "text"
    ],
    "errorMessage": null,
    "triggerData": null,
    "workflowId": null,
    "workflowName": null
  }
]

Retrieve a workflow run

get

Retrieve details of a specific workflow run execution by its ID, including execution history and status.

Authorizations
Path parameters
workflowIdstringRequired

WorkflowRun identifier

idstringRequired

WorkflowRun identifier

Responses
200

WorkflowRun resource

get
GET /workflows/{workflowId}/runs/{id} HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "createdAt": "2025-08-20T03:44:53.834Z",
  "updatedAt": "2025-08-20T03:44:53.834Z",
  "completedAt": null,
  "status": "running",
  "context": [
    "text"
  ],
  "executedNodes": [
    "text"
  ],
  "errorMessage": null,
  "triggerData": null,
  "workflowId": null,
  "workflowName": null
}
PreviousTransactionNextModels