curl --request GET \
--url https://app.octavehq.com/api/v2/segment/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": "<string>",
"createdAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"unrecognized": true,
"rejected": true,
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"active": true,
"data": {
"fitExplanation": "<string>",
"firmographics": {},
"keyPriorities": [
"<string>"
],
"keyConsiderations": [
"<string>"
],
"uniqueApproach": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
}
}
]
}List segments with optional filtering and pagination
curl --request GET \
--url https://app.octavehq.com/api/v2/segment/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": "<string>",
"createdAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"unrecognized": true,
"rejected": true,
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"active": true,
"data": {
"fitExplanation": "<string>",
"firmographics": {},
"keyPriorities": [
"<string>"
],
"keyConsiderations": [
"<string>"
],
"uniqueApproach": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"user": {
"oId": "<string>",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "<string>"
}
}
]
}Filter by segment OIds
Filter by product OId
Text search query
Limit
Offset
Segment list data
Whether there are more results
false
Total number of results
0
Show child attributes
Segment OId
Creation date
Segment name
Segment internal name
Segment description
Updated date
Show child attributes
Qualifying questions
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