Skip to main content
GET
List prompts

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard under Settings > API keys.

Query Parameters

topic_id
integer | null

Filter by topic ID

brand_scopes[]
enum<string>[] | null

Filter by brand scope (branded or non_branded).

Available options:
branded,
non_branded
intents[]
enum<string>[] | null

Filter by prompt intent.

Available options:
informational,
comparative,
transactional,
navigational
website_id
integer
required

Target website id

Response

Successful Response

prompts
PromptBaseSchema · object[]
required
topic_id
integer | null
topic_name
string | null
average_visibility
number
default:0