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

> ## Agent Instructions
> Treat Stackdome as an application-delivery platform for coding agents and developers, not as a Kubernetes dashboard.
> Prefer the Stackdome agent plugin as the user entry point and the stackdome CLI as the execution interface.
> Route agents who need the maintained deploy skill to npx skills add stackdome/skills and the complete operational workflow to /guides/ai-agents.
> Verify commands and flags with stackdome --help. Run stackdome init before authoring stackfile.yaml and stackdome validate before deploying.
> Use -o json for automation and verify documented terminal states before claiming success.
> Never request a user's account password. Use API-token authentication.
> During alpha, Stackdome Cloud is ephemeral and capacity-limited, and each organization can connect one cluster.
> Do not expose Kubernetes as a user concern unless the task is self-hosting or infrastructure architecture.

# List preview stacks for a project



## OpenAPI

````yaml /openapi.yaml get /api/v1/organizations/{org_id}/projects/{project_name}/preview-stacks
openapi: 3.0.0
info:
  description: >-
    Deploy, debug, and operate applications through the Stackdome REST API on
    Stackdome Cloud or a self-hosted installation. This API is in alpha and may
    change before general availability.
  title: Stackdome API
  version: 0.0.1-alpha
servers:
  - url: /
security: []
paths:
  /api/v1/organizations/{org_id}/projects/{project_name}/preview-stacks:
    get:
      tags:
        - Preview Stacks
      summary: List preview stacks for a project
      operationId: listPreviewStacks
      parameters:
        - description: The ID of the organization
          explode: false
          in: path
          name: org_id
          required: true
          schema:
            type: string
          style: simple
        - description: The name of the project
          explode: false
          in: path
          name: project_name
          required: true
          schema:
            type: string
          style: simple
        - description: Page number
          explode: true
          in: query
          name: page
          required: false
          schema:
            default: 1
            type: integer
          style: form
        - description: Number of items per page
          explode: true
          in: query
          name: page_size
          required: false
          schema:
            default: 20
            type: integer
          style: form
        - description: Filter by preview config ID
          explode: true
          in: query
          name: config_id
          required: false
          schema:
            type: string
          style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewStackList'
          description: List of preview stacks
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      security:
        - Bearer: []
components:
  schemas:
    PreviewStackList:
      example:
        total: 0
        page: 6
        total_pages: 5
        items:
          - commit: commit
            annotations:
              - value: value
                key: key
              - value: value
                key: key
            created_at: '2000-01-23T04:56:07.000Z'
            source: manual
            deletion_timestamp: '2000-01-23T04:56:07.000Z'
            branch: branch
            labels:
              - value: value
                key: key
              - value: value
                key: key
            organisation_id: organisation_id
            updated_at: '2000-01-23T04:56:07.000Z'
            project_id: project_id
            user_id: user_id
            config_id: config_id
            stack_id: stack_id
            image_overrides:
              key: image_overrides
            name: name
            pr_number: pr_number
            id: id
            status:
              phase: Provisioning
              outputs:
                commit_sha: commit_sha
                urls:
                  - resource: resource
                    url: url
                  - resource: resource
                    url: url
              reason: reason
              message: message
          - commit: commit
            annotations:
              - value: value
                key: key
              - value: value
                key: key
            created_at: '2000-01-23T04:56:07.000Z'
            source: manual
            deletion_timestamp: '2000-01-23T04:56:07.000Z'
            branch: branch
            labels:
              - value: value
                key: key
              - value: value
                key: key
            organisation_id: organisation_id
            updated_at: '2000-01-23T04:56:07.000Z'
            project_id: project_id
            user_id: user_id
            config_id: config_id
            stack_id: stack_id
            image_overrides:
              key: image_overrides
            name: name
            pr_number: pr_number
            id: id
            status:
              phase: Provisioning
              outputs:
                commit_sha: commit_sha
                urls:
                  - resource: resource
                    url: url
                  - resource: resource
                    url: url
              reason: reason
              message: message
        page_size: 1
      properties:
        items:
          items:
            $ref: '#/components/schemas/PreviewStack'
          type: array
        total:
          description: Total number of records
          type: integer
        page:
          description: Current page number
          type: integer
        page_size:
          description: Number of items per page
          type: integer
        total_pages:
          description: Total number of pages
          type: integer
      type: object
    Error:
      allOf:
        - $ref: '#/components/schemas/ObjectReference'
        - $ref: '#/components/schemas/Error_allOf'
    PreviewStack:
      example:
        commit: commit
        annotations:
          - value: value
            key: key
          - value: value
            key: key
        created_at: '2000-01-23T04:56:07.000Z'
        source: manual
        deletion_timestamp: '2000-01-23T04:56:07.000Z'
        branch: branch
        labels:
          - value: value
            key: key
          - value: value
            key: key
        organisation_id: organisation_id
        updated_at: '2000-01-23T04:56:07.000Z'
        project_id: project_id
        user_id: user_id
        config_id: config_id
        stack_id: stack_id
        image_overrides:
          key: image_overrides
        name: name
        pr_number: pr_number
        id: id
        status:
          phase: Provisioning
          outputs:
            commit_sha: commit_sha
            urls:
              - resource: resource
                url: url
              - resource: resource
                url: url
          reason: reason
          message: message
      properties:
        id:
          readOnly: true
          type: string
        organisation_id:
          readOnly: true
          type: string
        project_id:
          readOnly: true
          type: string
        user_id:
          readOnly: true
          type: string
        config_id:
          type: string
        stack_id:
          type: string
        name:
          type: string
        pr_number:
          type: string
        branch:
          type: string
        commit:
          readOnly: true
          type: string
        source:
          enum:
            - manual
            - webhook
          type: string
        status:
          $ref: '#/components/schemas/PreviewStack_status'
        image_overrides:
          additionalProperties:
            type: string
          type: object
        labels:
          items:
            $ref: '#/components/schemas/Label'
          type: array
        annotations:
          items:
            $ref: '#/components/schemas/Annotation'
          type: array
        deletion_timestamp:
          format: date-time
          type: string
        created_at:
          format: date-time
          readOnly: true
          type: string
        updated_at:
          format: date-time
          readOnly: true
          type: string
      type: object
    ObjectReference:
      properties:
        id:
          type: string
        kind:
          type: string
        href:
          type: string
      type: object
    Error_allOf:
      properties:
        code:
          type: string
        reason:
          type: string
        operation_id:
          type: string
        details:
          additionalProperties: true
          description: Optional structured, machine-readable error context
          type: object
      type: object
    PreviewStack_status:
      example:
        phase: Provisioning
        outputs:
          commit_sha: commit_sha
          urls:
            - resource: resource
              url: url
            - resource: resource
              url: url
        reason: reason
        message: message
      properties:
        phase:
          enum:
            - Provisioning
            - Deploying
            - Ready
            - Failed
            - Deleting
          type: string
        reason:
          type: string
        message:
          type: string
        outputs:
          $ref: '#/components/schemas/PreviewStack_status_outputs'
      readOnly: true
      type: object
    Label:
      additionalProperties: false
      example:
        value: value
        key: key
      properties:
        key:
          type: string
        value:
          type: string
      required:
        - key
        - value
      type: object
    Annotation:
      example:
        value: value
        key: key
      properties:
        key:
          type: string
        value:
          type: string
      required:
        - key
        - value
      type: object
    PreviewStack_status_outputs:
      example:
        commit_sha: commit_sha
        urls:
          - resource: resource
            url: url
          - resource: resource
            url: url
      properties:
        commit_sha:
          type: string
        urls:
          items:
            $ref: '#/components/schemas/PreviewStack_status_outputs_urls_inner'
          type: array
      type: object
    PreviewStack_status_outputs_urls_inner:
      example:
        resource: resource
        url: url
      properties:
        resource:
          type: string
        url:
          type: string
      type: object
  securitySchemes:
    Bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````