v1

latestOpenAPI 3.1.02026-07-263370112.1 KB

List Prompts

Returns a paginated list of active prompts for the specified brand, including their variants, tags, and topics. Use this endpoint to retrieve all prompts configured for AI visibility tracking.

get/{brand_id}/prompts

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.

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.

Response

Successful Response

totalinteger required

offsetinteger

limitinteger nullable