Skip to main content
GET
/
api
/
v2
/
reference
/
get
Get Reference
curl --request GET \
  --url https://app.octavehq.com/api/v2/reference/get \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "oId": "r_1234",
  "createdAt": "2021-01-01",
  "data": {
    "howTheyMakeMoney": "<string>",
    "howTheyUseProduct": "<string>",
    "howTheyBenefitFromProduct": "<string>",
    "emailSnippets": [
      "<string>"
    ],
    "howWeImpactedTheirBusiness": [
      "<string>"
    ],
    "keyStats": [
      "<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
}

Authorizations

​
api_key
string
header
required

Query Parameters

​
oId
string
required

Reference OId

Response

Reference data

​
_metadata
object
required
​
oId
string
required

The ID of the reference

Minimum string length: 1
Example:

"r_1234"

​
createdAt
string
required

The date and time the reference was created

Example:

"2021-01-01"

​
data
object
required
​
user
object
required
​
workspace
object
required
​
name
string | null

The external facing name of the reference

Example:

"Large filesharing service"

​
internalName
string | null

The internal name of the reference

Example:

"Dropbox"

​
updatedAt
string | null

The date and time the reference was updated

Example:

"2021-01-01"

​
deletedAt
string | null

The date and time the reference was deleted

Example:

"2021-01-01"

​
archivedAt
string | null

The date and time the reference was archived

Example:

"2021-01-01"

​
description
string | null

The description of the reference

Example:

"Description of the reference"

​
active
boolean
default:true

Whether the reference is active and can be used

Example:

true

​
unrecognized
boolean | null

Whether the reference is unrecognized

Example:

false