Skip to main content
GET
List Prompts
Prompts are the questions Qwairy monitors across AI platforms. Each prompt is categorized by funnel stage (TOFU/MOFU/BOFU), tagged for organization, and linked to a topic. Track which prompts generate mentions and source citations for your brand.
See Entities for the complete Prompt object structure, and Topic / Tag for classification objects.
string
required
Bearer token. Example: Bearer qw-api-xxx

Path Parameters

string
required
The unique identifier of the brand

Query Parameters

number
Number of days to include. Returns prompts that received at least one answer within the window. If not specified, returns all data.
string
Start date (ISO 8601, e.g. 2026-03-05). Returns prompts with at least one answer on or after this date.
string
End date (ISO 8601, e.g. 2026-03-31). Returns prompts with at least one answer on or before this date.
When a date range is provided, both the prompt list and the per-prompt include=details aggregations (answersCount, competitors[].mentions, brandMentionCount, sources[].citations) are scoped to that window. Prompts that ran multiple times still appear if at least one of their runs falls inside the range.
string
Filter by topic ID (keywordId). Supports comma-separated multi-select (e.g., id1,id2).
string
Filter by tag ID. Supports comma-separated multi-select (e.g., id1,id2).
string
Filter by prompt type: TOFU, MOFU, BOFU
number
default:"50"
Maximum number of prompts to return (max: 100)
number
default:"0"
Pagination offset
string
default:"lastGeneratedAt"
Field to sort by: lastGeneratedAt, answersCount, text, createdAt
string
default:"desc"
Sort order: asc or desc
string
Set to details to enrich each prompt with aggregated competitors, sources, brand mentions, and source stability metrics. When omitted, the response includes only the base fields listed below.

Response

boolean
Indicates if the request was successful
object
array

Example Request

Example Response

Example with include=details