Sign in

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 to return archived prompts, or status=all to include active, paused, and 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
'active' | 'paused' | 'archived'
OR
'all'

Filter prompts by lifecycle status. Defaults to active.

  • active - Only currently tracked prompts
  • paused - Prompts whose collection is paused; their history stays visible
  • archived - Only soft-deleted prompts
  • all - Active, paused, and archived prompts

Response

Successful Response

totalinteger required
offsetinteger
limitinteger nullable

Changes

Changed in 2 of the 11 revisions of this API.11

  • e6a40681f3731See the full diff
    • ○

      added the enum value paused to the property anyOf[subschema #1]/ of the query request parameter status

      request-parameter-property-enum-value-added

  • 10f2a17e0cd21See the full diff
    • ●

      added the new paused enum value to the // response property for the response status

      response-property-enum-value-added