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": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "archivedAt": "<string>",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "active": true,
  "data": {
    "fitExplanation": "<string>",
    "firmographics": {},
    "keyPriorities": [
      "<string>"
    ],
    "keyConsiderations": [
      "<string>"
    ],
    "uniqueApproach": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "qualifyingQuestions": [
    {
      "question": "<string>",
      "rationale": "<string>",
      "fitType": "GOOD",
      "weight": "MEDIUM",
      "archivedAt": "<string>"
    }
  ],
  "user": {
    "oId": "<string>"
  },
  "workspace": {
    "oId": "<string>"
  },
  "unrecognized": true,
  "rejected": true
}

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Segment OId

Response

200
application/json

Segment data

The response is of type object.