Get Playbook
curl --request GET \
--url https://app.octavehq.com/api/v2/playbook/get \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/playbook/get"
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/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://app.octavehq.com/api/v2/playbook/get",
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/get"
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/get")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/playbook/get")
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"
},
"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,
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"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
}
]
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Get Playbook
Get Playbook by OId
GET
/
api
/
v2
/
playbook
/
get
Get Playbook
curl --request GET \
--url https://app.octavehq.com/api/v2/playbook/get \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/playbook/get"
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/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://app.octavehq.com/api/v2/playbook/get",
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/get"
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/get")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/playbook/get")
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"
},
"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,
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"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
}
]
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Query Parameters
Playbook OId
Response
Playbook data
Show child attributes
Show child attributes
Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
LEGACY, SECTOR, SOLUTION, MILESTONE, PRACTITIONER, COMPETITIVE, ACCOUNT, CUSTOM, null Available options:
CVI_WHY_CHANGE, null Available options:
active, draft, archived Available options:
specific, none Available options:
specific, none Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I