curl --request GET \
--url https://app.octavehq.com/api/v2/playbook/list \
--header 'api_key: <api-key>'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"data": [
{
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"explanation": "<string>",
"attributes": {},
"icpConcerns": [],
"icpPriorities": [],
"keyInsight": [],
"statusQuo": [],
"differentiatedValue": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"shared": true,
"type": "LEGACY",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
},
"product": {
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"capabilities": [
"Capability 1",
"Capability 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>"
]
}
]
},
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "<string>",
"archivedAt": "<string>",
"deletedAt": "<string>",
"updatedAt": "<string>",
"title": "<string>",
"details": "<string>",
"context": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
}
}
],
"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"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"sequenceTemplates": [
{
"oId": "<string>",
"name": "<string>",
"persona": {
"oId": "<string>",
"name": "<string>"
},
"status": "active"
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"howTheyMakeMoney": "<string>",
"howTheyUseProduct": "<string>",
"howTheyBenefitFromProduct": "<string>",
"emailSnippets": [
"<string>"
],
"howWeImpactedTheirBusiness": [
"<string>"
],
"keyStats": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"description": "<string>"
}
],
"segment": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
},
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
}
]
}
],
"total": 123
}
List Playbooks
curl --request GET \
--url https://app.octavehq.com/api/v2/playbook/list \
--header 'api_key: <api-key>'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"data": [
{
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"explanation": "<string>",
"attributes": {},
"icpConcerns": [],
"icpPriorities": [],
"keyInsight": [],
"statusQuo": [],
"differentiatedValue": [],
"exampleDomains": [],
"exampleDescription": "",
"approachAngle": [
"<string>"
],
"strategicNarrative": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"shared": true,
"type": "LEGACY",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"user": {
"oId": "<string>"
},
"workspace": {
"oId": "<string>"
},
"product": {
"oId": "<string>",
"name": "<string>",
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"capabilities": [
"Capability 1",
"Capability 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>"
]
}
]
},
"description": "<string>"
},
"buyerPersonas": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"hypotheses": [
{
"oId": "<string>",
"createdAt": "<string>",
"archivedAt": "<string>",
"deletedAt": "<string>",
"updatedAt": "<string>",
"title": "<string>",
"details": "<string>",
"context": "<string>",
"persona": {
"name": "<string>",
"oId": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>"
},
"user": {
"name": "<string>",
"oId": "<string>"
}
}
],
"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"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
}
}
],
"sequenceTemplates": [
{
"oId": "<string>",
"name": "<string>",
"persona": {
"oId": "<string>",
"name": "<string>"
},
"status": "active"
}
],
"references": [
{
"oId": "<string>",
"name": "<string>",
"data": {
"howTheyMakeMoney": "<string>",
"howTheyUseProduct": "<string>",
"howTheyBenefitFromProduct": "<string>",
"emailSnippets": [
"<string>"
],
"howWeImpactedTheirBusiness": [
"<string>"
],
"keyStats": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"description": "<string>"
}
],
"segment": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
},
"competitor": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
},
"proofPoints": [
{
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"data": "<any>"
}
]
}
],
"total": 123
}
Text to search for
Limit the number of results
Offset the results
Product OId
Playbook data
The response is of type object
.