Bot templates
List a playbook's subjects
With a bot’s run login: the subjects a playbook may act on now, each assigned an arm by Fluid before the bot sees it. Only treatment subjects are listed, as references with a touch id; held-out subjects are counted. A live playbook whose messages cannot be sent lists none and says why in blockers. One call reads at most 500 matches, newest first; when matches remain, next_cursor is set and passing it as cursor reads on from there. The run needs the playbook’s read permission.
GET
/
api
/
company
/
v2026-10
/
bot-runs
/
current
/
playbook-subjects
List a playbook's subjects
curl --request GET \
--url https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects', 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.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"playbook_subjects": {
"playbook": "declined_subscription",
"mode": "live",
"held_out_count": 1,
"blockers": [],
"subjects": [
{
"touch_id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a90",
"subject_id": "481",
"value_cents": 4999,
"currency_code": "USD",
"item_count": 1,
"product_ids": [
77
],
"hours_since_event": 30,
"failure_group": "insufficient_funds",
"prior_touches": 0
}
],
"next_cursor": null
},
"status": 200,
"meta": {
"request_uuid": "7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583",
"timestamp": "2026-10-22T15:32:08Z"
}
}{
"message": "Invalid credentials."
}{
"message": "Only a running bot can call this"
}{
"error": {
"message": "Not found",
"details": {}
},
"status": 404,
"meta": {
"request_uuid": "7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583",
"timestamp": "2026-10-22T15:32:08Z"
}
}{
"error": {
"message": "The bot's owner has not switched this playbook on",
"details": {
"type": "playbook_off"
}
},
"status": 409,
"meta": {
"request_uuid": "7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583",
"timestamp": "2026-10-22T15:32:08Z"
}
}{
"error": {
"message": "That cursor is not one this endpoint answered",
"details": {
"type": "invalid_cursor"
}
},
"status": 422,
"meta": {
"request_uuid": "7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583",
"timestamp": "2026-10-22T15:32:08Z"
}
}Authorizations
A bot's run login, minted for one run.
Query Parameters
The playbook key.
The next_cursor of an earlier call, to read older matches.
⌘I
List a playbook's subjects
curl --request GET \
--url https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects', 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.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/company/v2026-10/bot-runs/current/playbook-subjects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"playbook_subjects": {
"playbook": "declined_subscription",
"mode": "live",
"held_out_count": 1,
"blockers": [],
"subjects": [
{
"touch_id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a90",
"subject_id": "481",
"value_cents": 4999,
"currency_code": "USD",
"item_count": 1,
"product_ids": [
77
],
"hours_since_event": 30,
"failure_group": "insufficient_funds",
"prior_touches": 0
}
],
"next_cursor": null
},
"status": 200,
"meta": {
"request_uuid": "7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583",
"timestamp": "2026-10-22T15:32:08Z"
}
}{
"message": "Invalid credentials."
}{
"message": "Only a running bot can call this"
}{
"error": {
"message": "Not found",
"details": {}
},
"status": 404,
"meta": {
"request_uuid": "7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583",
"timestamp": "2026-10-22T15:32:08Z"
}
}{
"error": {
"message": "The bot's owner has not switched this playbook on",
"details": {
"type": "playbook_off"
}
},
"status": 409,
"meta": {
"request_uuid": "7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583",
"timestamp": "2026-10-22T15:32:08Z"
}
}{
"error": {
"message": "That cursor is not one this endpoint answered",
"details": {
"type": "invalid_cursor"
}
},
"status": 422,
"meta": {
"request_uuid": "7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583",
"timestamp": "2026-10-22T15:32:08Z"
}
}