Skip to main content
GET
List Suggestions

Authorizations

api_key
string
header
required

Query Parameters

statuses
enum<string>[]

Filter by status. Defaults to ['pending'] — the items awaiting review, matching the Suggestions inbox default.

Available options:
draft,
pending,
accepted,
rejected,
dismissed,
expired
changeTypes
enum<string>[]

Filter by change type: 'add' (new entity) or 'refine' (change to an existing one). Omit to include both.

Available options:
add,
refine
targetEntityTypes
enum<string>[]

Filter by the library entity type being added or refined (e.g. Persona, Product, UseCase, Competitor). Omit to include all.

Available options:
Product,
Service,
Solution,
Persona,
UseCase,
Reference,
Segment,
Competitor,
Alternative,
BuyingTrigger,
CoreFeature,
Objection,
ProofPoint,
Playbook,
Agent,
Hypothesis,
BrandVoice,
Resource
daysBack
integer

Look back this many days from now. Defaults to 14 (the inbox default). Ignored when startDate is provided.

Required range: x > 0
startDate
string<date-time> | null

Only include suggestions created on or after this date (ISO 8601). Overrides daysBack when set.

endDate
string<date-time> | null

Only include suggestions created on or before this date (ISO 8601).

sourceTypes
enum<string>[]

Restrict to suggestions originating from these sources (e.g. ANALYTICS, DIRECT_FINDINGS, USER_CREATED). Omit to include all sources.

Available options:
analytics,
brand_voice,
user_created,
ask_octave,
ask_octave_manual,
resource,
crm_import,
direct_findings,
trends
limit
integer
default:20

Max results to return (1-100, default 20).

Required range: 0 < x <= 100
offset
integer | null
default:0

Pagination offset (default 0).

Required range: x >= 0
sortDirection
enum<string>
default:desc

Sort by createdAt. Defaults to 'desc' (newest first).

Available options:
asc,
desc

Response

List of entity suggestions for the workspace

_metadata
object
required
suggestions
object[]
required
total
number
required

Total suggestions matching the filters.

counts
object
required

Status counts across the timeframe/filters, ignoring the status filter.

nextOffset
number | null
required

Offset for the next page, or null when there are no more results.