List Playbooks
curl --request GET \
--url https://app.octavehq.com/api/v2/playbook/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/playbook/list"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://app.octavehq.com/api/v2/playbook/list', 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://app.octavehq.com/api/v2/playbook/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/playbook/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/playbook/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/playbook/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": [
{
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"data": {
"explanation": "<string>",
"attributes": {},
"keyInsight": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"methodology": {
"type": "CVI_WHY_CHANGE",
"data": {
"coreNarrative": [
"<string>"
],
"stages": {
"A1": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A2": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A3": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A4": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A5": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
}
},
"generatedAt": "<string>"
}
}
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"workspace": {
"oId": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "2023-11-07T05:31:56Z"
}
],
"active": true,
"type": "LEGACY",
"framework": "CVI_WHY_CHANGE",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"product": {
"type": "PRODUCT",
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [
"Capability 1",
"Capability 2"
],
"keyFunctionality": [
"Functionality 1",
"Functionality 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"description": "<string>"
},
"service": {
"oId": "<string>",
"name": "<string>",
"data": null,
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"details": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
},
"archivedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"data": {
"internalName": "<string>",
"primaryResponsibilities": [
"Responsibility 1",
"Responsibility 2"
],
"painPoints": [
"Pain Point 1",
"Pain Point 2"
],
"keyConcerns": [
"Concern 1",
"Concern 2"
],
"keyObjectives": [
"Objective 1",
"Objective 2"
],
"commonJobTitles": [
"Job Title 1",
"Job Title 2"
],
"whyTheyMatterToUs": [
"Reason 1",
"Reason 2"
],
"whyWeMatterToThem": [
"Reason 1",
"Reason 2"
],
"buyingRole": [
"Economic buyer with budget authority over the GTM stack.",
"Experienced operator who has evaluated similar tooling before."
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
}
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"description": "<string>"
}
],
"segment": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
},
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
}
]
}
],
"total": 123
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Legacy Playbooks
List Playbooks
List Playbooks
GET
/
api
/
v2
/
playbook
/
list
List Playbooks
curl --request GET \
--url https://app.octavehq.com/api/v2/playbook/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/playbook/list"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://app.octavehq.com/api/v2/playbook/list', 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://app.octavehq.com/api/v2/playbook/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/playbook/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/playbook/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/playbook/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": [
{
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"data": {
"explanation": "<string>",
"attributes": {},
"keyInsight": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"methodology": {
"type": "CVI_WHY_CHANGE",
"data": {
"coreNarrative": [
"<string>"
],
"stages": {
"A1": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A2": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A3": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A4": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
},
"A5": {
"overview": [
"<string>"
],
"whatToKnow": [
"<string>"
],
"whatToDo": [
"<string>"
],
"whatToSay": [
"<string>"
]
}
},
"generatedAt": "<string>"
}
}
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"workspace": {
"oId": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "2023-11-07T05:31:56Z"
}
],
"active": true,
"type": "LEGACY",
"framework": "CVI_WHY_CHANGE",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"product": {
"type": "PRODUCT",
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [
"Capability 1",
"Capability 2"
],
"keyFunctionality": [
"Functionality 1",
"Functionality 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"description": "<string>"
},
"service": {
"oId": "<string>",
"name": "<string>",
"data": null,
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"details": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
},
"archivedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"data": {
"internalName": "<string>",
"primaryResponsibilities": [
"Responsibility 1",
"Responsibility 2"
],
"painPoints": [
"Pain Point 1",
"Pain Point 2"
],
"keyConcerns": [
"Concern 1",
"Concern 2"
],
"keyObjectives": [
"Objective 1",
"Objective 2"
],
"commonJobTitles": [
"Job Title 1",
"Job Title 2"
],
"whyTheyMatterToUs": [
"Reason 1",
"Reason 2"
],
"whyWeMatterToThem": [
"Reason 1",
"Reason 2"
],
"buyingRole": [
"Economic buyer with budget authority over the GTM stack.",
"Experienced operator who has evaluated similar tooling before."
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"strategicImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
}
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"description": "<string>"
}
],
"segment": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
},
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": null
}
]
}
],
"total": 123
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Query Parameters
Text to search for
Limit the number of results
Offset the results
Filter by offering OId. Accepts Product, Service, and Solution OIds.
@deprecated Use offeringOId instead. Filter by offering OId (Product, Service, or Solution). Kept for backward compatibility.