latestOpenAPI 3.1.02026-08-204087139.4 KB
c4fe20c603a3
List Prompts
Returns a paginated list of prompts for the specified brand, including their variants, tags, and topics. Defaults to active prompts; pass status=archived or status=all to include archived prompts.
get/{brand_id}/prompts
Path parameters
brand_idinteger required
The unique identifier for the brand
The unique identifier for the brand
Query parameters
limitinteger
Maximum number of prompts to return per page.
Maximum number of prompts to return per page.
offsetinteger
Number of prompts to skip for pagination.
Number of prompts to skip for pagination.
stagestring nullable
Filter prompts by journey stage — the name of one of the brand's stages (custom stage names included). Default sets:
- Advice - Prompts seeking recommendations or guidance
- Awareness - Prompts exploring a topic or problem space
- Evaluation - Prompts assessing specific options
- Comparison - Prompts comparing multiple options
- Other - Prompts that don't fit other categories
Filter prompts by journey stage — the name of one of the brand's stages (custom stage names included). Default sets:
- Advice - Prompts seeking recommendations or guidance
- Awareness - Prompts exploring a topic or problem space
- Evaluation - Prompts assessing specific options
- Comparison - Prompts comparing multiple options
- Other - Prompts that don't fit other categories
Filter prompts by lifecycle status. Defaults to active.
- active - Only currently tracked prompts
- archived - Only soft-deleted prompts
- all - Both active and archived prompts
Response
Successful Response