---
title: "List the partner's studies"
method: GET
path: "/api/v1/studies"
tags: ["Studies"]
---

# List the partner's studies

`GET /api/v1/studies`

## Request

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

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).

## Query parameters

- `externalUserId` string
- `from` string, date
- `to` string, date
- `page` integer
- `pageSize` integer

## Response `200`

OK

- StudySummaryModelPagedList
  - `totalCount` integer
  - `page` integer
  - `pageSize` integer
  - `items` StudySummaryModel[], nullable
    - `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, nullable: Headline yearly saving in Currency, if computed.
    - `currency` string, nullable: ISO 4217 currency of the money amounts (currently always `"CZK"`).
    - `paybackYears` number, double, nullable: Payback in years, if computed.
    - `url` string, nullable: Absolute URL of the public broker endpoint that redirects to the study PDF. Null once redacted (the stored PDF is deleted).
    - `studyLabel` string, nullable: The free-form label the study was created with, if any. Null once redacted.
    - `externalUserId` string, nullable: The caller's end-user id the study was tagged with, if any.
    - `recipientEmail` string, nullable: Who the study was e-mailed to, if it went out by e-mail. Null once redacted.
    - `recipientName` string, nullable: The recipient's full name, if supplied. Null once redacted.
    - `recipientPhone` string, nullable: 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, nullable: Web origin of an embedded-calculator call, if any.
    - `redactedAt` string, date-time, nullable: When the calculation's personal data was erased; null for live rows.
    - `userId` string, uuid, nullable: The console user who generated it; null for API-generated studies.
    - `partnerId` string, uuid: The owning partner — always the caller's own.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden

## Changes

- **2026-11-03** `50555858fb42`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cubee/apis/partner-api/changes/api/v1/studies/get.md)

---

[API](https://skmtc.dev/cubee/apis/partner-api.md) - [All operations](https://skmtc.dev/cubee/apis/partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cubee/apis/partner-api/revisions/50555858fb42?raw)