List persona

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

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "hasNext": false,
  "total": 0,
  "data": [
    {
      "oId": "p_1234",
      "createdAt": "<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>"
            ]
          }
        ]
      },
      "user": {
        "oId": "u_1234",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "wa_1234"
      },
      "name": "VP of Sales",
      "internalName": "Sally the Sales Leader",
      "description": "<string>",
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "updatedAt": "<string>",
      "unrecognized": false,
      "rejected": false,
      "active": true,
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ]
    }
  ]
}

GET

api

persona

list

List persona

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

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "hasNext": false,
  "total": 0,
  "data": [
    {
      "oId": "p_1234",
      "createdAt": "<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>"
            ]
          }
        ]
      },
      "user": {
        "oId": "u_1234",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "wa_1234"
      },
      "name": "VP of Sales",
      "internalName": "Sally the Sales Leader",
      "description": "<string>",
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "updatedAt": "<string>",
      "unrecognized": false,
      "rejected": false,
      "active": true,
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ]
    }
  ]
}

Authorizations

api_key

string

header

required

Query Parameters

text

string | null

Text search query

limit

number

default:10

Limit

Required range: x > 0

Example:

10

offset

number | null

default:0

Offset

Required range: x >= 0

Example:

0

productOId

string | null

Product OId

playbookOId

string | null

Playbook OId

Response

Persona 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"

hasNext

boolean

required

Whether there are more results

Example:

false

total

number

required

Total number of results

Example:

0

data

object[]

required

Show child attributes

data.oId

string

required

Persona OId

Minimum string length: 1

Example:

"p_1234"

data.createdAt

string | null

required

Creation date

data.data

object

required

Show child attributes

data.data.internalName

string | null

The internal name of the persona

data.data.primaryResponsibilities

string[]

The primary responsibilities of the persona

Example:

["Responsibility 1", "Responsibility 2"]

data.data.painPoints

string[]

The pain points of the persona

Example:

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

data.data.keyConcerns

string[]

The key concerns of the persona

Example:

["Concern 1", "Concern 2"]

data.data.keyObjectives

string[]

The key objectives of the persona

Example:

["Objective 1", "Objective 2"]

data.data.commonJobTitles

string[]

The common job titles of the persona

Example:

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

data.data.whyTheyMatterToUs

string[]

The reasons why the persona matters to us

Example:

["Reason 1", "Reason 2"]

data.data.whyWeMatterToThem

string[]

The reasons why we matter to this type of persona

Example:

["Reason 1", "Reason 2"]

data.data.customFields

object[]

Show child attributes

data.data.customFields.title

string

required

data.data.customFields.value

string[]

required

data.user

object

required

User data

Show child attributes

data.user.oId

string | null

The ID of the user who created the persona

Example:

"u_1234"

data.user.firstName

string | null

The first name of the user who created the persona

Example:

"John"

data.user.lastName

string | null

The last name of the user who created the persona

Example:

"Doe"

data.workspace

object

required

Workspace data

Show child attributes

data.workspace.oId

string | null

The ID of the workspace that the persona belongs to

Example:

"wa_1234"

data.name

string | null

Persona name

Example:

"VP of Sales"

data.internalName

string | null

The internal name of the persona

Example:

"Sally the Sales Leader"

data.description

string | null

Persona description

data.deletedAt

string | null

Deleted date

data.archivedAt

string | null

Archived date

data.updatedAt

string | null

Updated date

data.unrecognized

boolean | null

Whether persona is unrecognized

Example:

false

data.rejected

boolean | null

Whether persona is rejected

Example:

false

data.active

boolean

default:true

Whether the persona is active and can be used

Example:

true

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

Get Persona Update Persona

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

List persona

Authorizations

Query Parameters

Response