Skip to main content
GET
/
api
/
v2
/
solution
/
list
List Solutions
curl --request GET \
  --url https://app.octavehq.com/api/v2/solution/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "sv_1234",
      "createdAt": "<string>",
      "data": {
        "internalName": "<string>",
        "summary": "<string>",
        "distinctCapabilities": [],
        "keyComponents": [],
        "customerBenefits": [],
        "challengesAddressed": [],
        "statusQuo": [],
        "differentiatedValue": [],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "workspace": {
        "oId": "<string>"
      },
      "locked": true,
      "updatedAt": "<string>",
      "archivedAt": "<string>",
      "deletedAt": "<string>",
      "name": "<string>",
      "internalName": "<string>",
      "description": "<string>",
      "primaryUrl": "<string>",
      "active": true,
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "linkedProducts": [],
      "linkedUseCases": [],
      "linkedPersonas": [],
      "linkedSegments": [],
      "lockedBy": {
        "oId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "picture": "<string>"
      }
    }
  ],
  "total": 123
}

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

api_key
string
header
required

Query Parameters

text
string | null

Text to search for

limit
number | null
default:10

Limit the number of results

offset
number | null
default:0

Offset the results

activeOnly
boolean | null
default:true

Only return active solutions

offeringOId
string | null

Filter by a single offering OId (solution)

offeringOIds
string[]

Filter by offering OIds (solutions)

Response

200 - application/json

Solutions list

_metadata
object
required
data
object[]
required
total
number
required

Total number of solutions matching the query