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>'
{
  "_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>"
    }
  ]
}

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

​
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