Skip to main content
GET
/
api
/
v2
/
service
/
get
Get Service
curl --request GET \
  --url https://app.octavehq.com/api/v2/service/get \
  --header 'api_key: <api-key>'
import requests

url = "https://app.octavehq.com/api/v2/service/get"

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/service/get', 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/service/get",
  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/service/get"

	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/service/get")
  .header("api_key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/service/get")

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"
  },
  "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>"
    }
  ]
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Service OId

Response

Service data

_metadata
object
required
oId
string
required

The ID of the service

Minimum string length: 1
Example:

"p_1234"

createdAt
string
required

The date and time the service was created

Example:

"2021-01-01"

data
object
required
user
object
required
workspace
object
required
updatedAt
string | null

The date and time the service was updated

Example:

"2021-01-01"

archivedAt
string | null

The date and time the service was archived

Example:

"2021-01-01"

deletedAt
string | null

The date and time the service was deleted

Example:

"2021-01-01"

name
string | null

The external facing name of the service

Example:

"Service Name"

internalName
string | null

The internal name of the service

Example:

"Service Internal Name"

description
string | null

The description of the service

Example:

"Service Description"

primaryUrl
string | null

The primary URL of the service

Example:

"https://www.service.com"

active
boolean
default:true

Whether the service is active and can be used

Example:

true

qualifyingQuestions
object[] | null