Skip to main content
GET
/
api
/
v2
/
reference
/
list
List References
curl --request GET \
  --url https://app.octavehq.com/api/v2/reference/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "r_1234",
      "createdAt": "2021-01-01",
      "data": {
        "businessModel": "<string>",
        "theirChallenge": "<string>",
        "howTheyUseUs": "<string>",
        "whyTheyChoseUs": "<string>",
        "impactTheySaw": [
          "<string>"
        ],
        "stakeholdersInvolved": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "u_1234",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "w_1234"
      },
      "name": "Large filesharing service",
      "internalName": "Dropbox",
      "updatedAt": "2021-01-01",
      "deletedAt": "2021-01-01",
      "archivedAt": "2021-01-01",
      "description": "Description of the reference",
      "active": true,
      "unrecognized": false
    }
  ],
  "total": 123
}

Authorizations

api_key
string
header
required

Query Parameters

text
string | null

Text to search for

limit
number | null
default:10

Limit the number of results

offset
number | null
default:0

Offset the results

offeringOId
string | null

Filter by offering OId. Accepts Product, Service, and Solution OIds.

productOId
string | null
deprecated

@deprecated Use offeringOId instead. Filter by offering OId (Product, Service, or Solution). Kept for backward compatibility.

playbookOId
string | null

Playbook OId

oIds
string[]

OIds

Response

Reference data

_metadata
object
required
data
object[]
required
total
number
required

Total number of results