---
title: "List Prompts"
method: GET
path: "/{brand_id}/prompts"
---

# List Prompts

`GET /{brand_id}/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.

## Path parameters

- `brand_id` integer, required — The unique identifier for the brand

## Query parameters

- `limit` integer — Maximum number of prompts to return per page.
- `offset` integer — Number of prompts to skip for pagination.
- `stage` string, 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
- `status` union — Filter prompts by lifecycle status. Defaults to `active`. - `active` - Only currently tracked prompts - `archived` - Only soft-deleted prompts - `all` - Both active and archived prompts
  - 'active' | 'archived'
  - 'all'

## Response `200`

Successful Response

- CollectionResponsePromptListing
  - `total` integer, required
  - `offset` integer
  - `limit` integer, nullable
  - `items` PromptListing[], required
    - `id` integer, required — Unique identifier for the prompt
    - `text` string, required — The prompt text being tracked
    - `stage` string, required — The customer journey stage this prompt represents — one of the brand's stages (custom stage names included)
    - `persona_id` integer, nullable, required — ID of the associated persona, if any
    - `platforms` string[], required — AI platforms this prompt is tracked on
    - `tags` string[], required — Custom tags assigned to this prompt
    - `topics` string[], required — Auto-detected or assigned topics for this prompt
    - `branded` boolean, required — Whether this prompt explicitly mentions the brand
    - `favorite` boolean, required — Whether this prompt is marked as a favorite
    - `status` 'active' | 'archived', required — Lifecycle status of the prompt (`active` or `archived`)
    - `created_at` string, date-time, required — Timestamp when the prompt was created
  - `metadata` TimeSeriesMetadata
    - `aggregation_granularity` 'daily' | 'weekly' | 'monthly', required
    - `period_count` integer, required — The number of periods in the time series
    - `start_date` string, date-time, required — The start date of the time series
    - `end_date` string, date-time, required — The end date of the time series
    - `top_domains` TopDomainsMetadata — Metadata about top domains, used by sources/domains endpoints.
      - `domains` TopDomainSummary[], required — Top domains by observation count (always domain-level aggregated)
        - `domain` string, required
        - `domain_owner` string, required
        - `observation_count` integer, required
      - `grand_total` integer, required — Total observation count across all domains (for calculating 'Other')
      - `owner_totals` object, required — Observation counts by owner type (brand, competitor, other)
      - `owner_time_series` OwnerTimeSeriesPoint[], nullable — Time series data by owner type for trend visualization
        - `time_bucket` string, required — Date string for the time bucket (YYYY-MM-DD)
        - `brand` integer, required — Observation count for brand-owned domains
        - `competitor` integer, required — Observation count for competitor-owned domains
        - `other` integer, required — Observation count for third-party domains
      - `segment_totals` SegmentTotal[] — Server-side observation counts per citation segment (covers all domains, not just top-N)
        - `name` string, required
        - `observation_count` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/scrunchai/apis/scrunch-data-api.md) · [All operations](https://skmtc.net/scrunchai/apis/scrunch-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scrunchai/scrunch-data-api/revisions/c4fe20c603a3/schema)