Skip to main content
GET
/
api
/
v2
/
segment
/
get
Get Segment
curl --request GET \
  --url https://app.octavehq.com/api/v2/segment/get \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "oId": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "unrecognized": true,
  "rejected": true,
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "archivedAt": "<string>",
  "active": true,
  "data": {
    "relevanceToOurBusiness": [],
    "firmographics": {
      "industry": [],
      "businessModel": [],
      "geography": [],
      "revenue": [],
      "employees": []
    },
    "firmographicCharacteristics": [],
    "definingAttributes": [],
    "businessDrivers": [],
    "strategicPriorities": [],
    "marketPressures": [],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "qualifyingQuestions": [
    {
      "question": "<string>",
      "rationale": "<string>",
      "fitType": "GOOD",
      "weight": "MEDIUM",
      "archivedAt": "<string>"
    }
  ],
  "user": {
    "oId": "<string>",
    "firstName": "John",
    "lastName": "Doe"
  },
  "workspace": {
    "oId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Segment OId

Response

Segment data

_metadata
object
required
oId
string
required

Segment OId

createdAt
string | null
required

Creation date

name
string
required

Segment name

internalName
string
required

Segment internal name

description
string
required

Segment description

unrecognized
boolean
required
rejected
boolean
required
updatedAt
string | null

Updated date

deletedAt
string | null
archivedAt
string | null
active
boolean
default:true
data
object
qualifyingQuestions
object[] | null

Qualifying questions

user
object

User data

workspace
object

Workspace data