Get a workflow

Get a single workflow together with a chosen slice of its related data: its details, its versions, one version in full, its run history, or one run in full.

Example: “Show me the details of the FAQ Suggester workflow”

Usage: give the workflow id and pick the slice with view: detail for the workflow itself, versions for its version history, version_detail for one version (needs the version id, and you can leave out the builder chat history), runs for its run history, or run_detail for one run (needs the run id). For runs you can filter by status, by where the run came from (a standalone playbook run, a grid cell, or a task), by a name search, or by when they were created, and the version and run lists come back in pages of up to 100 (50 by default).

Response: the workflow and whichever slice you asked for: its details, a list of versions, one version’s step config and chat, a list of runs, or one run’s status and progress.

POST /api/v1/business/workflows/get

Get a workflow

cURL

curl --request POST \
  --url https://api.example.com/api/v1/business/workflows/get \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "include_conversation": true,
  "run_status": [],
  "run_search": "<string>",
  "run_source": "playbook",
  "run_sort_by": "created_at",
  "sort_order": "desc",
  "created_after": "2023-11-07T05:31:56Z",
  "created_before": "2023-11-07T05:31:56Z",
  "page": 1,
  "size": 50
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-project-id · string<uuid> · required

Project ID for tenant scoping

X-Workspace-Id · string<uuid> | null

Overrides the key's workspace

X-API-Key · string | null

User API key

Body

application/json

view · enum<string> · required

Which slice to return for the workflow

Available options: detail, versions, version_detail, runs, run_detail

workflow_id · string<uuid> · required

Workflow id

version_id · string<uuid> | null

Version id (required for view='version_detail')

workflow_run_id · string<uuid> | null

Run id (required for view='run_detail')

include_conversation · boolean · default: true

Include builder conversation in version_detail; set false when the question only asks for the step config/graph and wants the chat history skipped.

run_status · enum<string>[] | null

Run status filter (view='runs')

Available options: pending, running, completed, failed, cancelled, awaiting_interaction

run_search · string | null

Match runs whose name contains this text, e.g. the 6-char suffix of a run name (view='runs')

run_source · enum<string> · default: playbook

Run source (view='runs'): 'playbook' for standalone runs (default - this filter applies even when left unset, so it only returns playbook-sourced runs), 'grid' for grid-cell runs, 'task' for task-triggered runs. run_search does not search across all sources by itself - check each run_source explicitly when the source is unknown.

Available options: grid, playbook, task

run_sort_by · enum<string> · default: created_at

Run sort field

Available options: created_at

sort_order · enum<string> · default: desc

Sort direction

Available options: asc, desc

created_after · string<date-time> | null

Runs created at/after this time

created_before · string<date-time> | null

Runs created at/before this time

page · integer · default: 1

1-based page (versions/runs)

Required range: x >= 1

size · integer · default: 50

Page size (versions/runs)

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response