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

# List Prompts

> Returns paginated prompts for a project in the current team. Returns 404 if the project does not belong to the current team.



## OpenAPI

````yaml /openapi.json get /api/v1/projects/{project}/prompts
openapi: 3.1.0
info:
  title: Surfacd Public API
  version: 1.0.0
  description: >-
    Public API for Surfacd. Team-scoped operations live under
    `/api/v1/team/...`; project collections live under `/api/v1/projects`;
    project-scoped operations live under `/api/v1/projects/{project}/...`. All
    endpoints require a Bearer team API key created in Team Settings. The API
    key selects the team for team-level and collection endpoints.
servers:
  - url: https://app.surfacd.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Project management endpoints. Reads only in this version.
  - name: Prompts
    description: Prompt management endpoints. Reads only in this version.
  - name: Team
    description: Team settings and plan details for the current team.
  - name: Reporting
    description: >-
      Read-only reporting endpoints for projects (brand rankings, mentions,
      visibility, matrix analysis, source data).
  - name: Reference
    description: Reference data used by create, update, and reporting filters.
  - name: Tags
    description: Project tag management endpoints.
paths:
  /api/v1/projects/{project}/prompts:
    parameters:
      - $ref: '#/components/parameters/ProjectUuid'
    get:
      tags:
        - Prompts
      summary: List Prompts
      description: >-
        Returns paginated prompts for a project in the current team. Returns 404
        if the project does not belong to the current team.
      operationId: v1ProjectsPromptsIndex
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/PromptStatus'
          description: Filter by prompt status.
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Free-text match against the prompt text.
      responses:
        '200':
          description: Paginated prompts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPrompt'
        '404':
          description: Project not found in the current team.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    ProjectUuid:
      name: project
      in: path
      required: true
      description: Project UUID.
      schema:
        type: string
        format: uuid
  schemas:
    PromptStatus:
      type: string
      enum:
        - suggestion
        - declined
        - inactive
        - active
    PaginatedPrompt:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Prompt'
        links:
          $ref: '#/components/schemas/PaginationLinks'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - data
        - meta
    Prompt:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        text:
          type: string
          description: The prompt text.
        keyword:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/PromptStatus'
        search_volume:
          type:
            - integer
            - 'null'
          description: Most recent search volume for the prompt's keyword, when known.
        topic:
          oneOf:
            - $ref: '#/components/schemas/PromptTopic'
            - type: 'null'
        country:
          $ref: '#/components/schemas/ProjectCountry'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/PromptTag'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - uuid
        - text
        - keyword
        - status
        - search_volume
        - topic
        - country
        - tags
        - created_at
        - updated_at
    PaginationLinks:
      type: object
      properties:
        first:
          type:
            - string
            - 'null'
        last:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
        next:
          type:
            - string
            - 'null'
      required:
        - first
        - last
        - prev
        - next
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/PaginationMetaLink'
        path:
          type:
            - string
            - 'null'
        per_page:
          type: integer
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
      required:
        - current_page
        - last_page
        - per_page
        - total
    ValidationError:
      type: object
      description: Returned when one or more request parameters fail validation.
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - message
        - errors
    PromptTopic:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
      required:
        - uuid
        - name
    ProjectCountry:
      type: object
      properties:
        code:
          type: string
          description: ISO 3166-1 alpha-2 country code (lowercase).
        name:
          type: string
      required:
        - code
        - name
    PromptTag:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        color:
          type:
            - string
            - 'null'
      required:
        - uuid
        - name
        - color
    PaginationMetaLink:
      type: object
      properties:
        url:
          type:
            - string
            - 'null'
        label:
          type: string
        active:
          type: boolean
      required:
        - url
        - label
        - active
  responses:
    ValidationError:
      description: Validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        Team API key created in Team Settings. Use it with URLs for the same
        team.

````