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

# Public proposal by token



## OpenAPI

````yaml get /api/v1/public/proposals/{token}
openapi: 3.1.0
info:
  title: PlanSync API
  version: 1.0.0
  description: >
    Customer-facing PlanSync API reference for common integrations.

    Authenticate with a project API key (`x-api-key: psk_…`) on project-scoped
    routes,

    or with a Better Auth session cookie from the signed-in web app.
servers:
  - url: https://api.plansync.dev
    description: Production API origin
  - url: http://localhost:3000
    description: Local app origin (proxied to backend)
security:
  - apiKeyAuth: []
  - cookieAuth: []
tags:
  - name: Health
  - name: Identity
  - name: Workspaces
  - name: Projects
  - name: Files
  - name: Issues
  - name: RFIs
  - name: Punch
  - name: Field Reports
  - name: Proposals
  - name: Operations
  - name: Schedule
  - name: Materials
  - name: Public Portals
  - name: Billing
paths:
  /api/v1/public/proposals/{token}:
    get:
      tags:
        - Public Portals
        - Proposals
      summary: Public proposal by token
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Proposal portal payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proposal'
        '404':
          $ref: '#/components/responses/NotFound'
      security: []
components:
  schemas:
    Proposal:
      type: object
      properties:
        id:
          type: string
        projectId:
          type: string
        title:
          type: string
        status:
          type: string
        total:
          type: string
      required:
        - id
        - projectId
        - title
        - status
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
      required:
        - error
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        Project API key (`psk_…`) from Project Settings → API keys.

        Required scopes depend on the route (e.g. `issues:read` for listing
        issues).

        Only works on project-scoped `/api/v1/projects/{projectId}/…` routes.
    cookieAuth:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Better Auth session cookie from a signed-in browser session.

````