curl --request GET \
--url https://app.octavehq.com/api/v2/segment/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": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<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>"
},
"workspace": {
"oId": "<string>"
},
"unrecognized": true,
"rejected": true
}
]
}
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": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"hasNext": false,
"total": 0,
"data": [
{
"oId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"archivedAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<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>"
},
"workspace": {
"oId": "<string>"
},
"unrecognized": true,
"rejected": true
}
]
}
Filter by segment OIds
Filter by product OId
Text search query
Limit
Offset
Segment list data
The response is of type object
.