Skip to main content
GET
List Use Cases

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

offeringOId
string | null

Filter by offering OId. Accepts Product, Service, and Solution OIds.

productOId
string | null
deprecated

@deprecated Use offeringOId instead. Filter by offering OId (Product, Service, or Solution). Kept for backward compatibility.

playbookOId
string | null

Playbook OId

oIds
string[]

OIds

Example:

Response

Use Case data

_metadata
object
required
total
number
required

Total number of use cases

data
object[]
required