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

# List preview deployments

> Returns all tracked preview deployments.



## OpenAPI

````yaml openapi.json get /api/previews
openapi: 3.0.3
info:
  title: Prvue Orchestrator API
  version: 0.1.0
  description: >-
    API for the preview deployer orchestrator: health checks, GitHub webhook,
    and preview lifecycle (list/delete).
servers:
  - url: http://localhost:3000
    description: Orchestrator API (on server; default ORCHESTRATOR_PORT)
security: []
paths:
  /api/previews:
    get:
      tags:
        - Previews
      summary: List preview deployments
      description: Returns all tracked preview deployments.
      operationId: listPreviews
      responses:
        '200':
          description: List of deployments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentsList'
        '500':
          description: Failed to list deployments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    DeploymentsList:
      type: object
      required:
        - deployments
      properties:
        deployments:
          type: array
          items:
            $ref: '#/components/schemas/Deployment'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
    Deployment:
      type: object
      description: Preview deployment info; aligns with IDeploymentInfo.
      properties:
        prNumber:
          type: integer
        repoName:
          type: string
        repoOwner:
          type: string
        projectSlug:
          type: string
          description: Slug from owner/name (e.g. myorg-myapp)
        deploymentId:
          type: string
          description: projectSlug-prNumber
        branch:
          type: string
        commitSha:
          type: string
        framework:
          type: string
          enum:
            - nestjs
            - go
            - laravel
            - rust
            - python
        dbType:
          type: string
          enum:
            - postgres
            - mysql
            - mongodb
        appPort:
          type: integer
        exposedAppPort:
          type: integer
        exposedDbPort:
          type: integer
        status:
          type: string
          enum:
            - building
            - running
            - failed
            - stopped
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        url:
          type: string
          description: Preview URL
          nullable: true
        commentId:
          type: integer
          nullable: true

````