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>'
import requests

url = "https://app.octavehq.com/api/v2/solution/list"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.octavehq.com/api/v2/solution/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.octavehq.com/api/v2/solution/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.octavehq.com/api/v2/solution/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/solution/list")
  .header("api_key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/solution/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "_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
}

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