GET
/
api
/
v2
/
segment
/
list
List segments
curl --request GET \
  --url https://app.octavehq.com/api/v2/segment/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "hasNext": false,
  "total": 0,
  "data": [
    {
      "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

oIds
string[]

Filter by segment OIds

productOId
string

Filter by product OId

textSearchQuery
string

Text search query

limit
number | null
default:10

Limit

offset
number | null
default:0

Offset

Response

200
application/json

Segment list data

The response is of type object.