curl --request GET \
--url https://app.octavehq.com/api/v2/persona/get \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"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 Persona by OId
curl --request GET \
--url https://app.octavehq.com/api/v2/persona/get \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"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>"
}
]
}Persona OId
Persona data
Persona OId
1"p_1234"
Creation date
Show child attributes
The internal name of the persona
The primary responsibilities of the persona
["Responsibility 1", "Responsibility 2"]The pain points of the persona
["Pain Point 1", "Pain Point 2"]The key concerns of the persona
["Concern 1", "Concern 2"]The key objectives of the persona
["Objective 1", "Objective 2"]The common job titles of the persona
["Job Title 1", "Job Title 2"]The reasons why the persona matters to us
["Reason 1", "Reason 2"]The reasons why we matter to this type of persona
["Reason 1", "Reason 2"]Persona name
"VP of Sales"
The internal name of the persona
"Sally the Sales Leader"
Persona description
Deleted date
Archived date
Updated date
Whether persona is unrecognized
false
Whether persona is rejected
false
Whether the persona is active and can be used
true
Show child attributes
The question to ask to qualify the entity
The rationale for the question as to why it helps qualify
The fit type of the question
GOOD, BAD "GOOD"
The weight of the question
LOW, MEDIUM, HIGH, INSTANT_QUALIFIER, INSTANT_DISQUALIFIER "MEDIUM"
The date and time the question was archived