List Services
curl --request GET \
--url https://app.octavehq.com/api/v2/service/list \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"total": 123,
"data": [
{
"oId": "p_1234",
"createdAt": "2021-01-01",
"data": {
"type": "SERVICE",
"summary": "<string>",
"deliverables": [
"Deliverable 1",
"Deliverable 2"
],
"competencies": [
"Competency 1",
"Competency 2"
],
"comparativeAdvantage": [
"Advantage 1",
"Advantage 2"
],
"likelyAlternative": [
"Alternative 1",
"Alternative 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "wa_1234"
},
"updatedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"name": "Service Name",
"internalName": "Service Internal Name",
"description": "Service Description",
"primaryUrl": "https://www.service.com",
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
}
]
}Service
List Services
List Services
GET
/
api
/
v2
/
service
/
list
List Services
curl --request GET \
--url https://app.octavehq.com/api/v2/service/list \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"total": 123,
"data": [
{
"oId": "p_1234",
"createdAt": "2021-01-01",
"data": {
"type": "SERVICE",
"summary": "<string>",
"deliverables": [
"Deliverable 1",
"Deliverable 2"
],
"competencies": [
"Competency 1",
"Competency 2"
],
"comparativeAdvantage": [
"Advantage 1",
"Advantage 2"
],
"likelyAlternative": [
"Alternative 1",
"Alternative 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "wa_1234"
},
"updatedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"name": "Service Name",
"internalName": "Service Internal Name",
"description": "Service Description",
"primaryUrl": "https://www.service.com",
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Query Parameters
Text search query
Limit
Offset
Service OId
⌘I