List Use Cases

curl --request GET \
  --url https://app.octavehq.com/api/v2/use-case/list \
  --header 'api_key: <api-key>'

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "total": 123,
  "data": [
    {
      "oId": "uc_1234",
      "createdAt": "2021-01-01",
      "user": {
        "oId": "<string>",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "<string>"
      },
      "updatedAt": "2021-01-01",
      "deletedAt": "2021-01-01",
      "archivedAt": "2021-01-01",
      "name": "Use Case Name",
      "internalName": "Use Case Internal Name",
      "description": "Use Case Description",
      "primaryUrl": "https://www.use-case.com",
      "active": true,
      "data": {
        "summary": "<string>",
        "scenarios": [
          "<string>"
        ],
        "desiredOutcomes": [
          "<string>"
        ],
        "businessDrivers": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "scenarios": [
        "<string>"
      ],
      "desiredOutcomes": [
        "<string>"
      ]
    }
  ]
}

GET

api

use-case

list

List Use Cases

curl --request GET \
  --url https://app.octavehq.com/api/v2/use-case/list \
  --header 'api_key: <api-key>'

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "total": 123,
  "data": [
    {
      "oId": "uc_1234",
      "createdAt": "2021-01-01",
      "user": {
        "oId": "<string>",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "<string>"
      },
      "updatedAt": "2021-01-01",
      "deletedAt": "2021-01-01",
      "archivedAt": "2021-01-01",
      "name": "Use Case Name",
      "internalName": "Use Case Internal Name",
      "description": "Use Case Description",
      "primaryUrl": "https://www.use-case.com",
      "active": true,
      "data": {
        "summary": "<string>",
        "scenarios": [
          "<string>"
        ],
        "desiredOutcomes": [
          "<string>"
        ],
        "businessDrivers": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "scenarios": [
        "<string>"
      ],
      "desiredOutcomes": [
        "<string>"
      ]
    }
  ]
}

Authorizations

api_key

string

header

required

Query Parameters

text

string | null

Text search query

limit

number | null

default:10

Limit

offset

number | null

default:0

Offset

productOId

string | null

Product OId

playbookOId

string | null

Playbook OId

oIds

string[]

OIds

Example:

["123", "456"]

Response

Use Case data

_metadata

object

required

Show child attributes

_metadata.requestId

string

required

Request ID

Example:

"requestId"

_metadata.timestamp

string

required

Timestamp

Example:

"2021-01-01T00:00:00.000Z"

_metadata.usage

number

default:0

API usage

Example:

0

_metadata.message

string

Message

Example:

"message"

total

number

required

Total number of use cases

data

object[]

required

Show child attributes

data.oId

string

required

The ID of the use case

Minimum string length: 1

Example:

"uc_1234"

data.createdAt

string

required

The date and time the use case was created

Example:

"2021-01-01"

data.user

object

required

Show child attributes

data.user.oId

string | null

User OId

data.user.firstName

string | null

The first name of the user who created the use case

Example:

"John"

data.user.lastName

string | null

The last name of the user who created the use case

Example:

"Doe"

data.workspace

object

required

Show child attributes

data.workspace.oId

string | null

Workspace OId

data.updatedAt

string | null

The date and time the use case was updated

Example:

"2021-01-01"

data.deletedAt

string | null

The date and time the use case was deleted

Example:

"2021-01-01"

data.archivedAt

string | null

The date and time the use case was archived

Example:

"2021-01-01"

data.name

string | null

The name of the use case

Example:

"Use Case Name"

data.internalName

string | null

The internal name of the use case

Example:

"Use Case Internal Name"

data.description

string | null

The description of the use case

Example:

"Use Case Description"

data.primaryUrl

string | null

The primary URL of the use case

Example:

"https://www.use-case.com"

data.active

boolean

default:true

Whether the use case is active and can be used

Example:

true

data.data

object

Show child attributes

data.data.summary

string | null

Summary

data.data.scenarios

string[] | null

Scenarios

data.data.desiredOutcomes

string[] | null

Desired Outcomes

data.data.businessDrivers

string[] | null

Business Drivers

data.data.customFields

object[]

Show child attributes

data.data.customFields.title

string

required

data.data.customFields.value

string[]

required

data.scenarios

string[] | null

Scenarios

data.desiredOutcomes

string[] | null

Desired Outcomes

Get Use Case Update Use Case

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

List Use Cases

Authorizations

Query Parameters

Response