Skip to main content
GET
/
api
/
v2
/
product
/
get
Get Product
curl --request GET \
  --url https://app.octavehq.com/api/v2/product/get \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "p_1234",
  "createdAt": "2021-01-01",
  "updatedAt": "2021-01-01",
  "archivedAt": "2021-01-01",
  "deletedAt": "2021-01-01",
  "name": "Product Name",
  "internalName": "Product Internal Name",
  "description": "Product Description",
  "primaryUrl": "https://www.product.com",
  "active": true,
  "data": {
    "type": "PRODUCT",
    "internalName": "<string>",
    "summary": "<string>",
    "capabilities": [
      "Capability 1",
      "Capability 2"
    ],
    "differentiatedValue": [
      "Differentiated Value 1",
      "Differentiated Value 2"
    ],
    "statusQuo": [
      "Status Quo 1",
      "Status Quo 2"
    ],
    "challengesAddressed": [
      "Challenge 1",
      "Challenge 2"
    ],
    "customerBenefits": [
      "Benefit 1",
      "Benefit 2"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "qualifyingQuestions": [
    {
      "question": "<string>",
      "rationale": "<string>",
      "fitType": "GOOD",
      "weight": "MEDIUM",
      "archivedAt": "<string>"
    }
  ],
  "user": {
    "oId": "u_1234",
    "firstName": "John",
    "lastName": "Doe"
  },
  "workspace": {
    "oId": "wa_1234"
  }
}

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Product OId

Response

Product data

_metadata
object
required
oId
string
required

The ID of the product

Minimum length: 1
Example:

"p_1234"

createdAt
string
required

The date and time the product was created

Example:

"2021-01-01"

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

The date and time the product was updated

Example:

"2021-01-01"

archivedAt
string | null

The date and time the product was archived

Example:

"2021-01-01"

deletedAt
string | null

The date and time the product was deleted

Example:

"2021-01-01"

name
string | null

The external facing name of the product

Example:

"Product Name"

internalName
string | null

The internal name of the product

Example:

"Product Internal Name"

description
string | null

The description of the product

Example:

"Product Description"

primaryUrl
string | null

The primary URL of the product

Example:

"https://www.product.com"

active
boolean
default:true

Whether the product is active and can be used

Example:

true

qualifyingQuestions
object[] | null
I