List workflows

curl --request POST \
  --url https://api.example.com/api/v1/business/workflows/query \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "search": "<string>",
  "sort_order": "desc",
  "page": 1,
  "size": 50
}
'

import requests

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

payload = {
    "search": "<string>",
    "sort_order": "desc",
    "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({search: '<string>', sort_order: 'desc', page: 1, size: 50})
};

fetch('https://api.example.com/api/v1/business/workflows/query', 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/query",
  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([
    'search' => '<string>',
    'sort_order' => 'desc',
    '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/query"

	payload := strings.NewReader("{\n  \"search\": \"<string>\",\n  \"sort_order\": \"desc\",\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/query")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"search\": \"<string>\",\n  \"sort_order\": \"desc\",\n  \"page\": 1,\n  \"size\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"search\": \"<string>\",\n  \"sort_order\": \"desc\",\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": {}
    }
  ]
}

Playbooks

List workflows

List the workflows in a project as a filterable inventory, or get the counts of workflows grouped by status.

Example: “pull up all my playbooks”

Usage: pick what you want with view — list for the inventory or counts for the status totals. For the list you can narrow by type (the curated system playbooks or the ones users built), by the latest version’s status, or by a text search over names, and you can sort by the field you choose. The list comes back in pages of up to 100 (50 by default); ask for the next page by its number.

Response: for the list, each workflow with its name, type, latest version status, and timings. For counts, the number of workflows in each status.

POST

api

business

workflows

query

List workflows

curl --request POST \
  --url https://api.example.com/api/v1/business/workflows/query \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "search": "<string>",
  "sort_order": "desc",
  "page": 1,
  "size": 50
}
'

import requests

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

payload = {
    "search": "<string>",
    "sort_order": "desc",
    "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({search: '<string>', sort_order: 'desc', page: 1, size: 50})
};

fetch('https://api.example.com/api/v1/business/workflows/query', 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/query",
  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([
    'search' => '<string>',
    'sort_order' => 'desc',
    '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/query"

	payload := strings.NewReader("{\n  \"search\": \"<string>\",\n  \"sort_order\": \"desc\",\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/query")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"search\": \"<string>\",\n  \"sort_order\": \"desc\",\n  \"page\": 1,\n  \"size\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"search\": \"<string>\",\n  \"sort_order\": \"desc\",\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

'list' for the paginated inventory, 'counts' for status counts

Available options:

list,

counts

type

enum<string> | null

Filter by workflow type: system (the curated Playbooks the tagging UI offers) or user (workflows built by users in this workspace).

Available options:

system,

user

string | null

Free-text search over workflow names

status

enum<string> | null

Filter by latest version status

Available options:

draft,

published

sort_by

enum<string> | null

Sort field

Available options:

created_at,

last_edited,

last_run

sort_order

enum<string>

default:desc

Sort direction

Available options:

asc,

desc

page

integer

default:1

1-based page number (list view)

Required range: x >= 1

size

integer

default:50

Page size (list view)

Required range: 1 <= x <= 100

Response

Successful Response

⌘I

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge Base & Brand Kit

Pages

Integrations & Attachments

List workflows

Headers

Body

Response