Skip to main content
GET
/
api
/
v2
/
persona
/
get
Get Persona
curl --request GET \
  --url https://app.octavehq.com/api/v2/persona/get \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "p_1234",
  "name": "VP of Sales",
  "internalName": "Sally the Sales Leader",
  "description": "<string>",
  "createdAt": "<string>",
  "deletedAt": "<string>",
  "archivedAt": "<string>",
  "updatedAt": "<string>",
  "unrecognized": false,
  "rejected": false,
  "active": true,
  "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>"
        ]
      }
    ]
  },
  "qualifyingQuestions": [
    {
      "question": "<string>",
      "rationale": "<string>",
      "fitType": "GOOD",
      "weight": "MEDIUM",
      "archivedAt": "<string>"
    }
  ],
  "user": {
    "oId": "u_1234",
    "firstName": "John",
    "lastName": "Doe"
  },
  "workspace": {
    "oId": "wa_1234"
  }
}

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Persona OId

Response

Persona data

_metadata
object
required
oId
string
required

Persona OId

Minimum length: 1
Example:

"p_1234"

createdAt
string | null
required

Creation date

data
object
required
user
object
required

User data

workspace
object
required

Workspace data

name
string | null

Persona name

Example:

"VP of Sales"

internalName
string | null

The internal name of the persona

Example:

"Sally the Sales Leader"

description
string | null

Persona description

deletedAt
string | null

Deleted date

archivedAt
string | null

Archived date

updatedAt
string | null

Updated date

unrecognized
boolean | null

Whether persona is unrecognized

Example:

false

rejected
boolean | null

Whether persona is rejected

Example:

false

active
boolean
default:true

Whether the persona is active and can be used

Example:

true

qualifyingQuestions
object[] | null
I