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

Request

  • Base URL
    https://api.scrunchai.com/v1
  • Auth
    HTTP bearer

Path parameters

brand_idinteger required

The unique identifier for the brand

Query parameters

limitinteger

Maximum number of prompts to return per page.

offsetinteger

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
'active' | 'paused' | 'archived'
OR
'all'

Response

Successful Response

totalinteger required
offsetinteger
limitinteger nullable

Changes

    • warning

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

    • info

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