Skip to main content
GET
/
api
/
v2
/
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>",
        "distinctCapabilities": [
          "Capability 1",
          "Capability 2"
        ],
        "keyFeatures": [
          "Feature 1",
          "Feature 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"
      },
      "type": "PRODUCT",
      "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

offeringOId
string | null

When type=ALL, restricts the combined list to rows whose oId is in this filter. Accepts Product, Service, or Solution OIds (each table is queried with the same id). When type is PRODUCT or SERVICE, only the product table is queried, so Service-table-only and Solution OIds typically return no rows.

productOId
string | null
deprecated

@deprecated Use offeringOId instead. Same semantics as offeringOId (alias for backward compatibility).

type
default:PRODUCT

Filter by offering type (PRODUCT, SERVICE, or ALL). When ALL, responses include solutions. Defaults to PRODUCT for backwards compatibility.

Available options:
PRODUCT,
SERVICE,
SOLUTION
Example:

"PRODUCT"

Response

List of offerings: product-table rows when type is PRODUCT or SERVICE; products, services, and solutions when type is ALL.

_metadata
object
required
total
number
required

Total matching rows (products only when type=PRODUCT or SERVICE; products, services, and solutions when type=ALL).

data
object[]
required

When type is ALL, combined offerings (product, service, solution). Otherwise product-table rows with a discriminating type field.