Skip to main content
GET
List recommendations

Authorizations

Authorization
string
header
required

API key from Settings → Security → API Keys. Pass as Authorization: Bearer YOUR_API_KEY.

Query Parameters

limit
integer

Maximum items to return (1–200, default 50).

Required range: 1 <= x <= 200
cursor
string

Opaque cursor from a previous response's pagination.next_cursor.

q
string

Case-insensitive search across resource, recommendation name, account name, region, category, service, recommended action, action type and model provider.

Maximum string length: 200
recommendationId
string[]

Recommendation ID (repeatable, up to 200).

Maximum array length: 200
resourceId
string[]

Resource ID, exact match (repeatable, up to 200).

Maximum array length: 200
recommendationName
string[]

Recommendation type, case-insensitive (repeatable).

Maximum array length: 200
category
string[]

Category, case-insensitive (repeatable).

Maximum array length: 200
accountId
string[]

Cloud account ID (repeatable).

Maximum array length: 200
region
string[]

Region, case-insensitive (repeatable).

Maximum array length: 200
service
string[]

Service, case-insensitive (repeatable).

Maximum array length: 200
status
enum<string>

Open (not dismissed), dismissed, or all. Defaults to all.

Available options:
open,
dismissed,
all
startDate
string

First detected on or after this day (yyyy-MM-dd).

endDate
string

First detected on or before this day (yyyy-MM-dd).

Response

List recommendations

data
object[]
required
pagination
object
required