> ## Documentation Index
> Fetch the complete documentation index at: https://paperplane-justin-winter-s-projects.vercel.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List published reviews

> Only 4- and 5-star reviews written about a real delivered order are published, newest first, capped at 24. `sample: true` marks an illustrative entry rather than a real customer; the live wall no longer seeds any, so in practice the flag is absent or false.



## OpenAPI

````yaml /openapi.json get /v1/reviews
openapi: 3.1.0
info:
  title: paperplane API
  version: 1.0.0
  summary: Send real physical mail from code.
  description: >-
    Upload a PDF or paste text; we print it and hand it to USPS the next
    business day. No account required — pay per letter with a Stripe link or a
    prepaid credit code, and use `sandbox: true` to exercise the whole flow for
    free.


    Every failure returns the same envelope: `status`, a stable machine-readable
    `code`, a human `reason`, and a `next` array of concrete recovery steps.


    This document is generated from the same zod schemas the server validates
    with, so it cannot describe an endpoint that does not exist.
  contact:
    name: paperplane support
    url: https://sendpaperplane.com/contact
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
  termsOfService: https://sendpaperplane.com/terms
servers:
  - url: https://sendpaperplane.com
    description: Production
security: []
tags:
  - name: Mail
    description: Quote, send, track, and cancel letters.
  - name: Credits
    description: Prepaid balances that pay for letters without a card.
  - name: Reviews
    description: Post-delivery feedback. Identity is derived from the order, not supplied.
  - name: Addresses
    description: >-
      Typeahead and reverse geocoding. Convenience only; USPS verification is
      authoritative.
  - name: Meta
    description: Machine-readable description of this API.
paths:
  /v1/reviews:
    get:
      tags:
        - Reviews
      summary: List published reviews
      description: >-
        Only 4- and 5-star reviews written about a real delivered order are
        published, newest first, capped at 24. `sample: true` marks an
        illustrative entry rather than a real customer; the live wall no longer
        seeds any, so in practice the flag is absent or false.
      operationId: listReviews
      responses:
        '200':
          description: Published reviews, newest first
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewListResponse'
              example:
                status: ok
                reviews:
                  - id: rev_a1b2c3d4
                    stars: 5
                    comment: >-
                      Sent a certified letter without leaving my desk. Arrived
                      in 3 days.
                    name: Jordan R.
                    city: Springfield
                    state: IL
                    category: certified
                    created_at: '2026-08-10T09:00:00.000Z'
components:
  schemas:
    ReviewListResponse:
      type: object
      properties:
        status:
          type: string
          const: ok
        reviews:
          type: array
          items:
            $ref: '#/components/schemas/Review'
      required:
        - status
        - reviews
    Review:
      type: object
      properties:
        id:
          type: string
        stars:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        comment:
          anyOf:
            - type: string
            - type: 'null'
        name:
          type: string
        city:
          type: string
        state:
          type: string
        category:
          type: string
        sample:
          type: boolean
        created_at:
          type: string
      required:
        - id
        - stars
        - comment
        - name
        - city
        - state
        - category
        - created_at

````