Skip to main content
GET
Get Sheet

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

sheetId
string<uuid>
required

Sheet UUID. Accepted in canonical, uppercase, braced, or unhyphenated form, as projectId is on POST /v1/templates/{code}/sheets.

Response

The sheet's current inputs, and results when it has been solved.

A sheet's identity and current inputs, plus the last solve's results while they still describe those inputs.

sheetId
string<uuid>
required

Unique identifier for the sheet.

projectId
string<uuid>
required

Project the sheet belongs to.

templateCode
string
required

Template the sheet was created from.

status
enum<string>
required

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.

Available options:
solved,
unsolved
inputs
object
required

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.

sheetUrl
string<uri>
required

Link to the sheet in the Calcs.com app.

passed
boolean | null
deprecated

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

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
string

Reference ID of the widget summaryCheck came from.

summaryCheckError
boolean

Whether the governing check could not be evaluated. A check in error has no verdict, whatever summaryCheck holds.

summaryCheckFailReasons
string[]

Why the governing check failed, when it did.

summaryCheckStatus
enum<string>

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.

Available options:
pass,
fail,
error,
not_evaluated
results
object

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.