SCscrunch

List Prompts

Changed on

Returns a paginated list of prompts for the specified brand, including their variants, tags, and topics. Defaults to active prompts; pass status=paused for paused prompts, status=archived for archived prompts, or status=all to include active, paused, and archived prompts.

get/{brand_id}/prompts

Request

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. Values are resolved from your brand's configured stages, so they vary per brand.

Default stage sets:

  • Intent (v1) — Advice, Awareness, Evaluation, Comparison, Other
  • Funnel (v2) — Awareness, Consideration, Conversion, Loyalty, Other

Brands that rename or add stages accept those custom names too. A value that doesn't match any of the brand's active stages matches zero rows rather than erroring.

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

  • e37811b6bc07Revision changes
    • info

      added the new optional query request parameter status

    • info

      added the required property // to the response with the status