List Playbooks

curl --request GET \
  --url https://app.octavehq.com/api/v2/playbook/list \
  --header 'api_key: <api-key>'

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "<string>",
      "createdAt": "<string>",
      "data": {
        "explanation": "<string>",
        "attributes": {},
        "icpConcerns": [],
        "icpPriorities": [],
        "keyInsight": [],
        "statusQuo": [],
        "differentiatedValue": [],
        "exampleDomains": [],
        "exampleDescription": "",
        "approachAngle": [
          "<string>"
        ],
        "strategicNarrative": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "workspace": {
        "oId": "<string>"
      },
      "product": {
        "type": "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>"
      },
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "name": "<string>",
      "description": "<string>",
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "shared": true,
      "active": true,
      "type": "LEGACY",
      "status": "active",
      "referenceMode": "specific",
      "proofPointMode": "none",
      "buyerPersonas": [
        {
          "oId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "hypotheses": [
            {
              "oId": "<string>",
              "createdAt": "<string>",
              "title": "<string>",
              "details": "<string>",
              "persona": {
                "name": "<string>",
                "oId": "<string>"
              },
              "playbook": {
                "name": "<string>",
                "oId": "<string>"
              },
              "user": {
                "name": "<string>",
                "oId": "<string>"
              },
              "archivedAt": "<string>",
              "deletedAt": "<string>",
              "updatedAt": "<string>",
              "context": "<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>"
                ]
              }
            ]
          }
        }
      ],
      "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": "<unknown>"
      },
      "competitor": {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "data": "<unknown>"
      },
      "proofPoints": [
        {
          "oId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "data": "<unknown>"
        }
      ]
    }
  ],
  "total": 123
}

GET

api

playbook

list

List Playbooks

curl --request GET \
  --url https://app.octavehq.com/api/v2/playbook/list \
  --header 'api_key: <api-key>'

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "<string>",
      "createdAt": "<string>",
      "data": {
        "explanation": "<string>",
        "attributes": {},
        "icpConcerns": [],
        "icpPriorities": [],
        "keyInsight": [],
        "statusQuo": [],
        "differentiatedValue": [],
        "exampleDomains": [],
        "exampleDescription": "",
        "approachAngle": [
          "<string>"
        ],
        "strategicNarrative": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "workspace": {
        "oId": "<string>"
      },
      "product": {
        "type": "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>"
      },
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "name": "<string>",
      "description": "<string>",
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "shared": true,
      "active": true,
      "type": "LEGACY",
      "status": "active",
      "referenceMode": "specific",
      "proofPointMode": "none",
      "buyerPersonas": [
        {
          "oId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "hypotheses": [
            {
              "oId": "<string>",
              "createdAt": "<string>",
              "title": "<string>",
              "details": "<string>",
              "persona": {
                "name": "<string>",
                "oId": "<string>"
              },
              "playbook": {
                "name": "<string>",
                "oId": "<string>"
              },
              "user": {
                "name": "<string>",
                "oId": "<string>"
              },
              "archivedAt": "<string>",
              "deletedAt": "<string>",
              "updatedAt": "<string>",
              "context": "<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>"
                ]
              }
            ]
          }
        }
      ],
      "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": "<unknown>"
      },
      "competitor": {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "data": "<unknown>"
      },
      "proofPoints": [
        {
          "oId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "data": "<unknown>"
        }
      ]
    }
  ],
  "total": 123
}

Authorizations

api_key

string

header

required

Query Parameters

text

string | null

Text to search for

limit

number | null

default:10

Limit the number of results

offset

number | null

default:0

Offset the results

productOId

string | null

Product OId

Response

Playbook data

_metadata

object

required

Show child attributes

_metadata.requestId

string

required

Request ID

Example:

"requestId"

_metadata.timestamp

string

required

Timestamp

Example:

"2021-01-01T00:00:00.000Z"

_metadata.usage

number

default:0

API usage

Example:

0

_metadata.message

string

Message

Example:

"message"

data

object[]

required

Show child attributes

data.oId

string

required

Minimum string length: 1

data.createdAt

string

required

data.data

object

required

Show child attributes

data.data.explanation

string | null

data.data.attributes

object

Show child attributes

data.data.attributes.{key}

string[]

data.data.icpConcerns

string[]

data.data.icpPriorities

string[]

data.data.keyInsight

string[]

data.data.statusQuo

string[]

data.data.differentiatedValue

string[]

data.data.exampleDomains

string[]

data.data.exampleDescription

string | null

default:""

data.data.approachAngle

string[] | null

data.data.strategicNarrative

string[] | null

data.data.customFields

object[]

Show child attributes

data.data.customFields.title

string

required

data.data.customFields.value

string[]

required

data.user

object

required

Show child attributes

data.user.oId

string | null

User OId

data.user.firstName

string | null

User first name

data.user.lastName

string | null

User last name

data.workspace

object

required

Show child attributes

data.workspace.oId

string | null

Workspace OId

data.product

object

required

Show child attributes

data.product.type

enum<string> | null

Offering type

Available options:

PRODUCT,

SERVICE

data.product.oId

string | null

Product OId

data.product.name

string | null

Product name

data.product.data

object

Show child attributes

data.product.data.type

enum<string>

default:PRODUCT

Available options:

PRODUCT,

SERVICE

data.product.data.internalName

string | null

The internal name of the product

data.product.data.summary

string | null

data.product.data.capabilities

string[]

Key capabilities of the product

Example:

["Capability 1", "Capability 2"]

data.product.data.differentiatedValue

string[]

The differentiated value of the product

Example:

[
  "Differentiated Value 1",
  "Differentiated Value 2"
]

data.product.data.statusQuo

string[]

The status quo of the product

Example:

["Status Quo 1", "Status Quo 2"]

data.product.data.challengesAddressed

string[]

The challenges addressed by the offering

Example:

["Challenge 1", "Challenge 2"]

data.product.data.customerBenefits

string[]

The customer benefits of the offering

Example:

["Benefit 1", "Benefit 2"]

data.product.data.customFields

object[]

Show child attributes

data.product.data.customFields.title

string

required

data.product.data.customFields.value

string[]

required

data.product.description

string | null

Product description

data.updatedAt

string | null

data.deletedAt

string | null

data.archivedAt

string | null

data.name

string | null

data.description

string | null

data.qualifyingQuestions

object[] | null

Show child attributes

data.qualifyingQuestions.question

string

required

The question to ask to qualify the entity

data.qualifyingQuestions.rationale

string

required

The rationale for the question as to why it helps qualify

data.qualifyingQuestions.fitType

enum<string>

required

The fit type of the question

Available options:

GOOD,

BAD

Example:

"GOOD"

data.qualifyingQuestions.weight

enum<string>

required

The weight of the question

Available options:

LOW,

MEDIUM,

HIGH,

INSTANT_QUALIFIER,

INSTANT_DISQUALIFIER

Example:

"MEDIUM"

data.qualifyingQuestions.archivedAt

string | null

The date and time the question was archived

data.shared

boolean

default:true

data.active

boolean

default:true

data.type

enum<string> | null

Available options:

LEGACY,

SECTOR,

SOLUTION,

MILESTONE,

PRACTITIONER,

COMPETITIVE,

ACCOUNT,

CUSTOM

data.status

enum<string>

default:active

Available options:

active,

draft,

archived

data.referenceMode

enum<string>

default:specific

Available options:

specific,

none

data.proofPointMode

enum<string>

default:none

Available options:

specific,

none

data.buyerPersonas

object[] | null

Show child attributes

data.buyerPersonas.oId

string | null

data.buyerPersonas.name

string | null

data.buyerPersonas.description

string | null

data.buyerPersonas.hypotheses

object[] | null

Show child attributes

data.buyerPersonas.hypotheses.oId

string

required

data.buyerPersonas.hypotheses.createdAt

string

required

data.buyerPersonas.hypotheses.title

string

required

data.buyerPersonas.hypotheses.details

string

required

data.buyerPersonas.hypotheses.persona

object

required

Show child attributes

data.buyerPersonas.hypotheses.persona.name

string | null

data.buyerPersonas.hypotheses.persona.oId

string | null

data.buyerPersonas.hypotheses.playbook

object

required

Show child attributes

data.buyerPersonas.hypotheses.playbook.name

string | null

data.buyerPersonas.hypotheses.playbook.oId

string | null

data.buyerPersonas.hypotheses.user

object

required

Show child attributes

data.buyerPersonas.hypotheses.user.name

string | null

data.buyerPersonas.hypotheses.user.oId

string | null

data.buyerPersonas.hypotheses.archivedAt

string | null

data.buyerPersonas.hypotheses.deletedAt

string | null

data.buyerPersonas.hypotheses.updatedAt

string | null

data.buyerPersonas.hypotheses.context

string | null

data.buyerPersonas.data

object

Show child attributes

data.buyerPersonas.data.internalName

string | null

The internal name of the persona

data.buyerPersonas.data.primaryResponsibilities

string[]

The primary responsibilities of the persona

Example:

["Responsibility 1", "Responsibility 2"]

data.buyerPersonas.data.painPoints

string[]

The pain points of the persona

Example:

["Pain Point 1", "Pain Point 2"]

data.buyerPersonas.data.keyConcerns

string[]

The key concerns of the persona

Example:

["Concern 1", "Concern 2"]

data.buyerPersonas.data.keyObjectives

string[]

The key objectives of the persona

Example:

["Objective 1", "Objective 2"]

data.buyerPersonas.data.commonJobTitles

string[]

The common job titles of the persona

Example:

["Job Title 1", "Job Title 2"]

data.buyerPersonas.data.whyTheyMatterToUs

string[]

The reasons why the persona matters to us

Example:

["Reason 1", "Reason 2"]

data.buyerPersonas.data.whyWeMatterToThem

string[]

The reasons why we matter to this type of persona

Example:

["Reason 1", "Reason 2"]

data.buyerPersonas.data.customFields

object[]

Show child attributes

data.buyerPersonas.data.customFields.title

string

required

data.buyerPersonas.data.customFields.value

string[]

required

data.useCases

object[] | null

Show child attributes

data.useCases.oId

string | null

data.useCases.name

string | null

data.useCases.description

string | null

data.useCases.data

object

Show child attributes

data.useCases.data.summary

string | null

Summary

data.useCases.data.scenarios

string[] | null

Scenarios

data.useCases.data.desiredOutcomes

string[] | null

Desired Outcomes

data.useCases.data.businessDrivers

string[] | null

Business Drivers

data.useCases.data.customFields

object[]

Show child attributes

data.useCases.data.customFields.title

string

required

data.useCases.data.customFields.value

string[]

required

data.references

object[] | null

Show child attributes

data.references.oId

string | null

data.references.name

string | null

data.references.data

object

Show child attributes

data.references.data.howTheyMakeMoney

string | null

data.references.data.howTheyUseProduct

string | null

data.references.data.howTheyBenefitFromProduct

string | null

data.references.data.emailSnippets

string[] | null

data.references.data.howWeImpactedTheirBusiness

string[] | null

data.references.data.keyStats

string[] | null

data.references.data.customFields

object[]

Show child attributes

data.references.data.customFields.title

string

required

data.references.data.customFields.value

string[]

required

data.references.description

string | null

data.segment

object

Show child attributes

data.segment.oId

string | null

data.segment.name

string | null

data.segment.description

string | null

data.segment.data

unknown

data.competitor

object

Show child attributes

data.competitor.oId

string | null

data.competitor.name

string | null

data.competitor.description

string | null

data.competitor.data

unknown

data.proofPoints

object[] | null

Show child attributes

data.proofPoints.oId

string | null

data.proofPoints.name

string | null

data.proofPoints.description

string | null

data.proofPoints.data

unknown

total

number

required

Total number of playbooks

Get Playbook Create Playbook

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

List Playbooks

Authorizations

Query Parameters

Response