Get a workflow

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
}
'

import requests

url = "https://api.example.com/api/v1/business/workflows/get"

payload = {
    "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
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.example.com/api/v1/business/workflows/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/business/workflows/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/business/workflows/get"

	payload := strings.NewReader("{\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"include_conversation\": true,\n  \"run_status\": [],\n  \"run_search\": \"<string>\",\n  \"run_source\": \"playbook\",\n  \"run_sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"created_after\": \"2023-11-07T05:31:56Z\",\n  \"created_before\": \"2023-11-07T05:31:56Z\",\n  \"page\": 1,\n  \"size\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/workflows/get")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"include_conversation\": true,\n  \"run_status\": [],\n  \"run_search\": \"<string>\",\n  \"run_source\": \"playbook\",\n  \"run_sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"created_after\": \"2023-11-07T05:31:56Z\",\n  \"created_before\": \"2023-11-07T05:31:56Z\",\n  \"page\": 1,\n  \"size\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/workflows/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"include_conversation\": true,\n  \"run_status\": [],\n  \"run_search\": \"<string>\",\n  \"run_source\": \"playbook\",\n  \"run_sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"created_after\": \"2023-11-07T05:31:56Z\",\n  \"created_before\": \"2023-11-07T05:31:56Z\",\n  \"page\": 1,\n  \"size\": 50\n}"

response = http.request(request)
puts response.read_body

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

POST

api

business

workflows

get

Get a workflow

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
}
'

import requests

url = "https://api.example.com/api/v1/business/workflows/get"

payload = {
    "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
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.example.com/api/v1/business/workflows/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/business/workflows/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/business/workflows/get"

	payload := strings.NewReader("{\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"include_conversation\": true,\n  \"run_status\": [],\n  \"run_search\": \"<string>\",\n  \"run_source\": \"playbook\",\n  \"run_sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"created_after\": \"2023-11-07T05:31:56Z\",\n  \"created_before\": \"2023-11-07T05:31:56Z\",\n  \"page\": 1,\n  \"size\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/workflows/get")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"include_conversation\": true,\n  \"run_status\": [],\n  \"run_search\": \"<string>\",\n  \"run_source\": \"playbook\",\n  \"run_sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"created_after\": \"2023-11-07T05:31:56Z\",\n  \"created_before\": \"2023-11-07T05:31:56Z\",\n  \"page\": 1,\n  \"size\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/workflows/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"include_conversation\": true,\n  \"run_status\": [],\n  \"run_search\": \"<string>\",\n  \"run_source\": \"playbook\",\n  \"run_sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"created_after\": \"2023-11-07T05:31:56Z\",\n  \"created_before\": \"2023-11-07T05:31:56Z\",\n  \"page\": 1,\n  \"size\": 50\n}"

response = http.request(request)
puts response.read_body

{
  "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

Successful Response

⌘I

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge & Brand

Content Intelligence

Integrations & Attachments

Get a workflow

Headers

Body

Response