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": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "data": [
    {
      "oId": "r_1234",
      "name": "Large filesharing service",
      "internalName": "Dropbox",
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01",
      "deletedAt": "2021-01-01",
      "archivedAt": "2021-01-01",
      "description": "Description of the reference",
      "active": true,
      "data": {
        "howTheyMakeMoney": "<string>",
        "howTheyUseProduct": "<string>",
        "howTheyBenefitFromProduct": "<string>",
        "emailSnippets": [
          "<string>"
        ],
        "howWeImpactedTheirBusiness": [
          "<string>"
        ],
        "keyStats": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "u_1234"
      },
      "workspace": {
        "oId": "w_1234"
      },
      "unrecognized": false
    }
  ],
  "total": 123
}

Authorizations

api_key
string
header
required

Query Parameters

text
string

Text to search for

limit
number | null
default:10

Limit the number of results

offset
number | null
default:0

Offset the results

productOId
string

Product OId

playbookOId
string

Playbook OId

oIds
string[]

OIds

Response

200
application/json

Reference data

The response is of type object.