Skip to main content
GET
/
{brand_id}
/
prompts
List Prompts
curl --request GET \
  --url https://api.scrunchai.com/v1/{brand_id}/prompts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 123,
      "text": "What are the best project management tools?",
      "stage": "Evaluation",
      "persona_id": 45,
      "platforms": [
        "chatgpt",
        "claude",
        "perplexity"
      ],
      "tags": [
        "software",
        "productivity"
      ],
      "topics": [
        "Project Management"
      ],
      "created_at": "2025-01-15T10:30:00Z"
    }
  ],
  "total": 250,
  "offset": 0,
  "limit": 100
}

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: 1 <= x <= 100
​
offset
integer
default:0

Number of prompts to skip for pagination.

Required range: x >= 0
​
stage
enum<string> | null

Filter prompts by journey stage.

Available stages:

  • 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
Available options:
Advice,
Awareness,
Evaluation,
Comparison,
Other

Response

Paginated list of prompts with metadata

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