List Products

curl --request GET \
  --url https://app.octavehq.com/api/v2/product/list \
  --header 'api_key: <api-key>'

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "total": 123,
  "data": [
    {
      "oId": "p_1234",
      "createdAt": "2021-01-01",
      "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>"
            ]
          }
        ]
      },
      "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": "Product Name",
      "internalName": "Product Internal Name",
      "description": "Product Description",
      "primaryUrl": "https://www.product.com",
      "active": true,
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ]
    }
  ]
}

GET

api

product

list

List Products

curl --request GET \
  --url https://app.octavehq.com/api/v2/product/list \
  --header 'api_key: <api-key>'

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "total": 123,
  "data": [
    {
      "oId": "p_1234",
      "createdAt": "2021-01-01",
      "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>"
            ]
          }
        ]
      },
      "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": "Product Name",
      "internalName": "Product Internal Name",
      "description": "Product Description",
      "primaryUrl": "https://www.product.com",
      "active": true,
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ]
    }
  ]
}

Authorizations

api_key

string

header

required

Query Parameters

text

string | null

Text

limit

number | null

default:10

Limit

offset

number | null

default:0

Offset

productOId

string | null

Product OId

Response

List of products

_metadata

object

required

Show child attributes

_metadata.requestId

string

required

Request ID

Example:

"requestId"

_metadata.timestamp

string

required

Timestamp

Example:

"2021-01-01T00:00:00.000Z"

_metadata.usage

number

default:0

API usage

Example:

0

_metadata.message

string

Message

Example:

"message"

total

number

required

Total number of products

data

object[]

required

List of products

Show child attributes

data.oId

string

required

The ID of the product

Minimum string length: 1

Example:

"p_1234"

data.createdAt

string

required

The date and time the product was created

Example:

"2021-01-01"

data.data

object

required

Show child attributes

data.data.type

enum<string>

default:PRODUCT

Available options:

PRODUCT,

SERVICE

data.data.internalName

string | null

The internal name of the product

data.data.summary

string | null

data.data.capabilities

string[]

Key capabilities of the product

Example:

["Capability 1", "Capability 2"]

data.data.differentiatedValue

string[]

The differentiated value of the product

Example:

[
  "Differentiated Value 1",
  "Differentiated Value 2"
]

data.data.statusQuo

string[]

The status quo of the product

Example:

["Status Quo 1", "Status Quo 2"]

data.data.challengesAddressed

string[]

The challenges addressed by the offering

Example:

["Challenge 1", "Challenge 2"]

data.data.customerBenefits

string[]

The customer benefits of the offering

Example:

["Benefit 1", "Benefit 2"]

data.data.customFields

object[]

Show child attributes

data.data.customFields.title

string

required

data.data.customFields.value

string[]

required

data.user

object

required

Show child attributes

data.user.oId

string | null

The ID of the user who created the product

Example:

"u_1234"

data.user.firstName

string | null

The first name of the user who created the product

Example:

"John"

data.user.lastName

string | null

The last name of the user who created the product

Example:

"Doe"

data.workspace

object

required

Show child attributes

data.workspace.oId

string | null

The ID of the workspace that the product belongs to

Example:

"wa_1234"

data.updatedAt

string | null

The date and time the product was updated

Example:

"2021-01-01"

data.archivedAt

string | null

The date and time the product was archived

Example:

"2021-01-01"

data.deletedAt

string | null

The date and time the product was deleted

Example:

"2021-01-01"

data.name

string | null

The external facing name of the product

Example:

"Product Name"

data.internalName

string | null

The internal name of the product

Example:

"Product Internal Name"

data.description

string | null

The description of the product

Example:

"Product Description"

data.primaryUrl

string | null

The primary URL of the product

Example:

"https://www.product.com"

data.active

boolean

default:true

Whether the product is active and can be used

Example:

true

data.qualifyingQuestions

object[] | null

Show child attributes

data.qualifyingQuestions.question

string

required

The question to ask to qualify the entity

data.qualifyingQuestions.rationale

string

required

The rationale for the question as to why it helps qualify

data.qualifyingQuestions.fitType

enum<string>

required

The fit type of the question

Available options:

GOOD,

BAD

Example:

"GOOD"

data.qualifyingQuestions.weight

enum<string>

required

The weight of the question

Available options:

LOW,

MEDIUM,

HIGH,

INSTANT_QUALIFIER,

INSTANT_DISQUALIFIER

Example:

"MEDIUM"

data.qualifyingQuestions.archivedAt

string | null

The date and time the question was archived

Get Product Create Product

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

List Products

Authorizations

Query Parameters

Response