> ## Documentation Index
> Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Prompts

> Get paginated list of prompts with search and filtering options



## OpenAPI

````yaml /v1/openapi.json get /prompts
openapi: 3.0.0
info:
  title: Promptwatch API
  description: API for customer integrations with Promptwatch monitoring platform
  version: 1.0.1
  contact:
    name: Promptwatch Support
    email: team@promptwatch.com
    url: https://promptwatch.com
  license:
    name: Commercial
    url: https://promptwatch.com/terms-and-conditions
servers:
  - url: https://server.promptwatch.com/api/v1
    description: Promptwatch API
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and data
  - name: Visibility
    description: Visibility data and insights
  - name: Citations
    description: Citation analytics and source tracking
  - name: Prompts
    description: Prompt management and operations
  - name: Analytics
    description: Analytics data and insights
  - name: Share of Voice
    description: Share of voice analytics showing brand mentions vs total responses
  - name: Responses
    description: Response analytics including mentions, competitors, and sentiment
paths:
  /prompts:
    get:
      tags:
        - Prompts
      summary: List Prompts
      description: Get paginated list of prompts with search and filtering options
      operationId: listPromptsV1
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          in: query
          name: page
          required: false
          description: Page number for pagination
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          in: query
          name: size
          required: false
          description: Number of items per page
        - schema:
            type: string
            format: uuid
          in: query
          name: llmMonitorId
          required: false
          description: Filter by specific monitor ID
        - schema:
            type: string
          in: query
          name: query
          required: false
          description: Search query for prompt text (full-text search)
        - schema:
            type: boolean
          in: query
          name: isActive
          required: false
          description: Filter by active/inactive status
        - schema:
            type: array
            items:
              type: string
              enum:
                - ORGANIC
                - BRAND_SPECIFIC
                - COMPETITOR_COMPARISON
          in: query
          name: types
          required: false
          description: Filter by prompt types
        - schema:
            type: string
            enum:
              - createdAt
              - updatedAt
              - isActive
              - type
              - intent
            default: createdAt
          in: query
          name: sortBy
          required: false
          description: Field to sort by
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          in: query
          name: sortOrder
          required: false
          description: Sort order
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  prompts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Prompt unique identifier
                        prompt:
                          type: string
                          description: The prompt text
                        type:
                          type: string
                          enum:
                            - ORGANIC
                            - BRAND_SPECIFIC
                            - COMPETITOR_COMPARISON
                          description: Type of prompt
                        intent:
                          type: string
                          enum:
                            - BRANDED
                            - INFORMATIONAL
                            - NAVIGATIONAL
                            - COMMERCIAL
                            - TRANSACTIONAL
                          nullable: true
                          description: Intent of the prompt
                        isActive:
                          type: boolean
                          description: Whether the prompt is active
                        languageCode:
                          type: string
                          description: Language code for the prompt
                        llmMonitorId:
                          type: string
                          format: uuid
                          description: Associated monitor ID
                        llmMonitor:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                          required:
                            - id
                            - name
                          additionalProperties: false
                        amountOfResponses:
                          type: number
                          description: Total number of responses for this prompt
                        averageVisibility:
                          type: number
                          nullable: true
                          description: Average visibility score across all responses
                        volume:
                          type: number
                          description: >-
                            Weighted search volume across all keywords (Google +
                            Bing + AI)
                        difficulty:
                          type: number
                          nullable: true
                          description: >-
                            Weighted average keyword difficulty across all
                            keywords
                        createdAt:
                          type: string
                          format: date-time
                          description: Prompt creation timestamp
                        updatedAt:
                          type: string
                          format: date-time
                          description: Prompt last update timestamp
                      required:
                        - id
                        - prompt
                        - type
                        - isActive
                        - languageCode
                        - llmMonitorId
                        - llmMonitor
                        - amountOfResponses
                        - volume
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                    description: Array of prompts
                  total:
                    type: number
                    description: Total number of prompts matching the query
                  page:
                    type: number
                    description: Current page number
                  size:
                    type: number
                    description: Number of items per page
                  totalPages:
                    type: number
                    description: Total number of pages
                required:
                  - prompts
                  - total
                  - page
                  - size
                  - totalPages
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error type
                  message:
                    type: string
                    description: Error message
                  details:
                    type: object
                    description: Additional error details
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error type
                  message:
                    type: string
                    description: Error message
                  details:
                    type: object
                    description: Additional error details
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get yours from the Promptwatch dashboard
        under Settings > API Keys.

````