GoliathDevelopersGet an API key
Reference/Workflowsgenerated from the gateway manifest

listWorkflowRuns

List runs of one workflow version.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

List runs of one workflow version (by workflowAutomationId), optionally by run status (PENDING | RUNNING | COMPLETED | PAUSED | STOPPED | FAILED | NOT_ENROLLED). Run ids feed pauseWorkflowRun / resumeWorkflowRun / stopWorkflowRun. Report each run's reason rather than saying reasons are unavailable: a NOT_ENROLLED run was refused at the door and never entered, and its stoppedReason says why (a STOPPED run's says why it was withdrawn); a PAUSED run carries pausedReason, plus sendFailureCode (the carrier code, e.g. 30007) when a failed text paused it; a PENDING run whose next send waits carries queuedSend.reason (DAILY_CAP | SEND_WINDOW | WINDOW_LIMIT | OUT_OF_SMS_CREDITS, null when the wait has no nameable cause; current only on a PENDING run, so go by pausedReason on a PAUSED one) and queuedSend.nextAttemptAt. A FAILED run has no reason field and an older STOPPED run's stoppedReason can be null: say it is not recorded, never invent one. Reasons are raw codes.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listWorkflowRuns",
    "variables": {
      "workflowAutomationId": "<workflowAutomationId>"
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.workflows.listWorkflowRuns({
  workflowAutomationId: '<workflowAutomationId>'
})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'listWorkflowRuns',
    variables: {
      workflowAutomationId: '<workflowAutomationId>'
    }
  }),
})
const { data, errors } = await res.json()

limit is clamped to 34.

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

workflowAutomationIdID!required
statuses[WorkflowAutomationRunStatus!]
PENDINGRUNNINGCOMPLETEDPAUSEDSTOPPEDFAILEDNOT_ENROLLED
limitInt

Default 20.

offsetInt

Default 0.

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "workflowAutomationsQuery": {
      "listWorkflowRuns": [
        {
          "id": "<ID>",
          "status": "PENDING",
          "dryRun": true,
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "scheduledExecution": "2026-01-01T00:00:00.000Z",
          "stoppedReason": "…",
          "pausedReason": "…",
          "sendFailureCode": "…",
          "queuedSend": {
            "reason": "DAILY_CAP",
            "nextAttemptAt": "2026-01-01T00:00:00.000Z"
          },
          "contact": {
            "id": "<ID>",
            "name": "…"
          }
        }
      ]
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READlistWorkflowsREADgetWorkflowREADgetWorkflowVersionGraphREADgetContentTemplateREADlistContentTemplatesREADlistContentTemplateFolders