Skip to main content
GET
Get a study

Path Parameters

id
string<uuid>
required

Response

OK

One study in full: the summary fields plus the stored request (input) and computed study (result) exactly as audited — the jsonb documents, which can be large when the request embedded custom hourly data. Once redacted, the personal values inside both documents (cover label/address, recipient, replication payload) are scrubbed; the calculation itself remains.

id
string<uuid>

The calculation id (also the stored PDF's blob name).

createdAt
string<date-time>

When it was generated (UTC).

annualSaving
number<double> | null

Headline yearly saving in Currency, if computed.

currency
string | null

ISO 4217 currency of the money amounts (currently always "CZK").

paybackYears
number<double> | null

Payback in years, if computed.

url
string | null

Absolute URL of the public broker endpoint that redirects to the study PDF. Null once redacted (the stored PDF is deleted).

studyLabel
string | null

The free-form label the study was created with, if any. Null once redacted.

externalUserId
string | null

The caller's end-user id the study was tagged with, if any.

recipientEmail
string | null

Who the study was e-mailed to, if it went out by e-mail. Null once redacted.

recipientName
string | null

The recipient's full name, if supplied. Null once redacted.

recipientPhone
string | null

The recipient's phone number, if supplied. Null once redacted.

wantsContact
boolean

Whether the customer agreed to a follow-up contact (see the request field).

origin
string | null

Web origin of an embedded-calculator call, if any.

redactedAt
string<date-time> | null

When the calculation's personal data was erased; null for live rows.

userId
string<uuid> | null

The console user who generated it; null for API-generated studies.

partnerId
string<uuid>

The owning partner — always the caller's own.

input
any | null

The calculator request the study was generated from, as stored.

result
any | null

The computed study model, as stored.