GET
/
api
/
v2
/
persona
/
list
List persona
curl --request GET \
  --url https://app.octavehq.com/api/v2/persona/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "hasNext": false,
  "total": 0,
  "data": [
    {
      "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"
      },
      "workspace": {
        "oId": "wa_1234"
      },
      "activeSequences": 123,
      "sentEmails": 123
    }
  ]
}

Authorizations

api_key
string
header
required

Query Parameters

text
string

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

Product OId

playbookOId
string

Playbook OId

Response

200
application/json

Persona data

The response is of type object.