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

# Get Sheet

> Retrieve a calculation sheet — any template — with its current inputs and, once solved, its results. The [Sheet Lifecycle guide](/templates/sheets-lifecycle) walks all four steps on one calculation.



## OpenAPI

````yaml api/openapi.json GET /v1/sheets/{sheetId}
openapi: 3.1.0
info:
  title: Connections Hub API
  version: 1.0.0
  description: >-
    Run HSS Connections Hub calculators programmatically: create projects,
    create and solve sheets from any calculator template, run batches, and
    export reports to PDF.


    All endpoints require API key authentication.
servers:
  - url: https://api.calcs.com
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Create and manage calculation projects. Each user can have multiple
      projects to organize their calculations.
  - name: Sheets
    description: >-
      Manage individual calculation sheets — read one back, update its inputs,
      solve or re-solve it, and delete single sheets or clean up many at once.
  - name: Templates
    description: >-
      Run calculations using any enabled template. Supports all calculator types
      without requiring endpoint-specific code.
paths:
  /v1/sheets/{sheetId}:
    get:
      tags:
        - Sheets
      summary: Get Sheet
      description: >-
        Retrieve a calculation sheet — any template — with its current inputs
        and, once solved, its results. The [Sheet Lifecycle
        guide](/templates/sheets-lifecycle) walks all four steps on one
        calculation.
      operationId: get-sheet
      parameters:
        - name: Authorization
          in: header
          required: true
          example: Bearer YOUR_KEY_HERE
          schema:
            type: string
          description: >-
            The `Authorization` header is used to authenticate with the API
            using your API key. Value is of the format `Bearer YOUR_KEY_HERE`.
        - name: sheetId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            Sheet UUID. Accepted in canonical, uppercase, braced, or
            unhyphenated form, as `projectId` is on `POST
            /v1/templates/{code}/sheets`.
      responses:
        '200':
          description: The sheet's current inputs, and results when it has been solved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SheetDetailResponse'
        '400':
          description: The sheetId path parameter is not a valid UUID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                non_uuid_sheet_id:
                  summary: sheetId is not a UUID
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: sheetId must be a UUID.
        '401':
          description: Unauthorized — missing or invalid API key.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                unauthorized:
                  summary: Missing or invalid API key
                  value:
                    type: https://httpproblems.com/http-status/401
                    title: Unauthorized
                    status: 401
                    detail: No Authorization Header
                    instance: /v1/sheets/84cb248b-a36f-41a9-9639-575bc597341e
                    trace:
                      timestamp: '2026-07-22T07:19:15.570Z'
                      requestId: 0a2d7511-aa02-45b6-86ce-1bb19c0486a2
                      buildId: 75f93f77-18bc-4f82-9a77-2e322a1bba58
                      rayId: a1f0ad123af1e6b3
        '404':
          description: The sheet does not exist, or is not accessible with this API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: Sheet does not exist, or is not accessible with this API key
                  value:
                    error:
                      code: NOT_FOUND
                      message: Sheet not found.
      security:
        - api_key: []
components:
  schemas:
    SheetDetailResponse:
      type: object
      description: >-
        A sheet's identity and current inputs, plus the last solve's results
        while they still describe those inputs.
      properties:
        sheetId:
          type: string
          format: uuid
          description: Unique identifier for the sheet.
        projectId:
          type: string
          format: uuid
          description: Project the sheet belongs to.
        templateCode:
          type: string
          description: Template the sheet was created from.
        status:
          type: string
          enum:
            - solved
            - unsolved
          description: >-
            `solved` while the stored results were computed from the inputs the
            sheet holds now. A sheet that has never been solved, or whose inputs
            changed since its last solve, is `unsolved` — re-solve to get
            results for the current inputs.
        inputs:
          type: object
          additionalProperties: true
          description: >-
            Current input values keyed by widget reference ID. Numbers read back
            as strings and booleans as `"1"`/`"0"`. An `enum` field reads back
            as its option label, as a string — the label listed in that field's
            `options` on `GET /v1/templates/{code}` — so a value you read can be
            displayed as-is or sent straight back in a `PATCH`. A value matching
            no option, such as a formula like `=projectDefault(...)`, is
            returned unchanged. A field whose `options` are numbers reads back
            as the string of that number (`2.8` publishes, `"2.8"` reads back),
            and accepts either form.
        passed:
          type:
            - boolean
            - 'null'
          deprecated: true
          description: >-
            Deprecated: read `summaryCheckStatus` for the current verdict.
            `passed` is not the latest solve's verdict: a failing calculation
            can report `true`, even on its first solve, or `null`. Present when
            solved.
        summaryCheck:
          type:
            - number
            - boolean
          description: >-
            Value of the template's governing check for the last solve. Absent
            when the check could not be evaluated (`summaryCheckStatus` is
            `error`). A template that defines no governing check reports `true`
            here, so read the verdict from `summaryCheckStatus`, which tells the
            two apart (`not_evaluated`).
        summaryCheckReferenceId:
          type: string
          description: Reference ID of the widget `summaryCheck` came from.
        summaryCheckError:
          type: boolean
          description: >-
            Whether the governing check could not be evaluated. A check in error
            has no verdict, whatever `summaryCheck` holds.
        summaryCheckFailReasons:
          type: array
          items:
            type: string
          description: Why the governing check failed, when it did.
        summaryCheckStatus:
          type: string
          enum:
            - pass
            - fail
            - error
            - not_evaluated
          description: >-
            Verdict of the template's governing check for the last solve.
            `pass`: the check passed (`summaryCheck` is `true`, or a number from
            0 to 1). `fail`: the check evaluated and failed (`false`, or a
            number outside 0 to 1). `error`: the check could not be evaluated —
            `summaryCheckError` is `true`, or the solve produced no value for a
            check the template defines; treat it as not passing.
            `not_evaluated`: the template defines no governing check. Present
            when solved.
        results:
          type: object
          additionalProperties: true
          description: >-
            Solved outputs, keyed by the reference IDs the template schema lists
            in `outputs[]`. A given solve returns the subset of those that apply
            to the inputs you sent. Present when solved.
        sheetUrl:
          type: string
          format: uri
          description: Link to the sheet in the Calcs.com app.
      required:
        - sheetId
        - projectId
        - templateCode
        - status
        - inputs
        - sheetUrl
    ValidationError:
      type: object
      description: Validation error response for invalid API inputs
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - VALIDATION_ERROR
              description: Error code for validation failures
            message:
              type: string
              description: Human-readable error summary
              example: Input validation failed
            details:
              type: array
              description: Array of specific validation errors
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: Path to the invalid field (e.g., 'L_X', 'supports.0.2')
                  message:
                    type: string
                    description: Description of what's wrong with the field
                required:
                  - field
                  - message
          required:
            - code
            - message
      required:
        - error
      example:
        error:
          code: VALIDATION_ERROR
          message: Input validation failed
          details:
            - field: L_X
              message: Expected number, received string
            - field: supports
              message: At least 2 supports are required
    ProblemDetails:
      type: object
      description: >-
        RFC 7807 (`application/problem+json`) error returned by the API gateway
        before a request reaches the handler — currently authentication failures
        (401). Note this differs from the `{ error: { code, message, details }
        }` envelope returned by the handler for validation and not-found errors.
      properties:
        type:
          type: string
          format: uri
          description: URI identifying the problem type.
        title:
          type: string
          description: Short, human-readable summary of the problem type.
        status:
          type: integer
          description: HTTP status code.
        detail:
          type: string
          description: Human-readable explanation specific to this occurrence.
        instance:
          type: string
          description: The request path that produced the error.
        trace:
          type: object
          description: >-
            Gateway trace metadata for support (timestamp, requestId, buildId,
            rayId).
      required:
        - type
        - title
        - status
        - detail
    ErrorResponse:
      type: object
      description: >-
        Standard error envelope for handler errors. `code` is a stable
        machine-readable error code (e.g. NOT_FOUND, UPSTREAM_ERROR); `message`
        is human-readable and may change.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send your API key as a bearer token: `Authorization: Bearer
        YOUR_API_KEY`. Every endpoint requires one.
    api_key:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.