CUcubee
Studies

Get a study

Changed on

One study in full: the summary fields plus the stored request (input) and computed study (result) exactly as audited — note the documents can be large when the request embedded custom hourly data. Partner-scoped like the list. Redacted studies return with redactedAt set, the personal values scrubbed out of both documents, and no link. The PDF itself is at GET /api/v1/studies/{id}/pdf.

get/api/v1/studies/{id}

Request

  • Base URL
    https://api.partner.cubee.cz
  • URL
    https://api.partner.cubee.cz/api/v1/studies/{id}
  • Auth
    none required

Path parameters

idstring uuid required

Response

OK

idstring uuid

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

createdAtstring date-time

When it was generated (UTC).

annualSavingnumber double nullable

Headline yearly saving in Currency, if computed.

currencystring nullable

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

paybackYearsnumber double nullable

Payback in years, if computed.

urlstring nullable

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

studyLabelstring nullable

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

externalUserIdstring nullable

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

recipientEmailstring nullable

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

recipientNamestring nullable

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

recipientPhonestring nullable

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

wantsContactboolean

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

originstring nullable

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

redactedAtstring date-time nullable

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

userIdstring uuid nullable

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

partnerIdstring uuid

The owning partner — always the caller's own.

inputunknown
resultunknown

Changes