CUcubee
Studies

List the partner's studies

Changed on

Returns the studies the calling API key's partner generated, newest first. Without parameters this is the partner's whole history; narrow it with externalUserId (the id the study was tagged with via the X-Cubee-External-User header — how an integrating site shows one end-user their own history) and/or a from/to date range (inclusive, on the generation date). Results are always scoped to the calling partner, so a caller only ever sees studies it created. Each item links to GET /api/v1/studies/{id}/pdf and carries the study's label, recipient, origin and end-user tag so a partner-wide list is tellable apart. Redacted studies are included with redactedAt set — their personal fields are erased and url is null (the stored PDF is deleted on redaction).

get/api/v1/studies

Request

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

Query parameters

externalUserIdstring

Only studies tagged with this end-user id.

fromstring date

Only studies generated on this date or later.

tostring date

Only studies generated on this date or earlier.

pageinteger

Page number for pagination (1-based).

pageSizeinteger

Number of items per page (max 200).

Response

OK

totalCountinteger
pageinteger
pageSizeinteger

Example response

{
  "totalCount": 2,
  "page": 1,
  "pageSize": 50,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2026-02-13T09:41:00+00:00",
      "annualSaving": 12095,
      "currency": "CZK",
      "paybackYears": 1.7,
      "url": "https://api.partner.cubee.cz/api/v1/studies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pdf",
      "studyLabel": "Novákovi — rodinný dům 10 kWp",
      "externalUserId": "eshop-user-8421",
      "recipientEmail": "novakovi@example.cz",
      "recipientName": "Jan Novák",
      "recipientPhone": "+420601123456",
      "wantsContact": true,
      "origin": null,
      "redactedAt": null,
      "userId": null,
      "partnerId": "8d2f6f0a-4c3b-4a6e-9f2d-1b7c9e5a3d10"
    },
    {
      "id": "5c2a1e10-8a1b-4d3c-9f2e-1a2b3c4d5e6f",
      "createdAt": "2026-01-30T14:12:00+00:00",
      "annualSaving": 6219,
      "currency": "CZK",
      "paybackYears": 3.2,
      "url": "https://api.partner.cubee.cz/api/v1/studies/5c2a1e10-8a1b-4d3c-9f2e-1a2b3c4d5e6f/pdf",
      "studyLabel": "Dvořáková — novostavba, zájem o FVE",
      "externalUserId": "eshop-user-9107",
      "recipientEmail": "dvorakova@example.cz",
      "recipientName": null,
      "recipientPhone": null,
      "wantsContact": true,
      "origin": "https://partner.example.cz",
      "redactedAt": null,
      "userId": null,
      "partnerId": "8d2f6f0a-4c3b-4a6e-9f2d-1b7c9e5a3d10"
    }
  ]
}

Changes