Skip to main content
GET
List Prompts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

The unique identifier for the brand

Query Parameters

limit
integer
default:100

Maximum number of prompts to return per page.

Required range: x >= 1
offset
integer
default:0

Number of prompts to skip for pagination.

Required range: x >= 0
stage
string | null

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
enum<string>
default:active

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
Available options:
active,
paused,
archived,
all

Response

Successful Response

total
integer
required
items
PromptListing · object[]
required
offset
integer
default:0
limit
integer | null
metadata
TimeSeriesMetadata · object | null