# List case studies

`GET https://app.pozyskajpacjenta.pl/api/v1/case-studies` · operationId `listCaseStudies` · since 1.1.0 · tag Entities

The clinic's published case studies, newest first. Responses are private to the key: `Cache-Control: private, max-age=60`, so cache them on your side for up to a minute.

## Request

Authorization: `Bearer <the clinic's key>`.

### cURL

```bash
curl "https://app.pozyskajpacjenta.pl/api/v1/case-studies" \
  -H "Authorization: Bearer $PP_API_KEY"
```

### TypeScript

```ts
import { PozyskajPacjentaClient } from "@pozyskajpacjenta/sdk";

const client = new PozyskajPacjentaClient({
  apiKey: process.env.PP_API_KEY ?? "",
  baseUrl: "https://app.pozyskajpacjenta.pl",
});

const { caseStudies } = await client.listCaseStudies();
```

### PHP

```php
<?php
$response = wp_remote_get(
    'https://app.pozyskajpacjenta.pl/api/v1/case-studies',
    array(
        'headers' => array( 'Authorization' => 'Bearer ' . getenv( 'PP_API_KEY' ) ),
        'timeout' => 10,
    )
);
if ( is_wp_error( $response ) ) {
    error_log( $response->get_error_message() );
    return;
}
$status = wp_remote_retrieve_response_code( $response );
$data   = json_decode( wp_remote_retrieve_body( $response ), true );
```

## Response

### 200: Published case studies.

- `caseStudies` (`CaseStudySummary[]`, required): The case studies.
  - `id` (`string`, required): Case study id.
  - `slug` (`string`, required): Slug from the case study's address.
  - `path` (`string`, required): Path of the case study page.
  - `title` (`string`, required): Title.
  - `summary` (`string | null`): Short summary; null when empty.
  - `image` (`MediaRef | null`): List image; null when none.
    - `url` (`string`, required): Absolute address of the file.
    - `focalX` (`integer | null`): Horizontal focal point in percent (0 to 100) to keep when cropping, e.g. as object-position.
    - `focalY` (`integer | null`): Vertical focal point in percent (0 to 100).
    - `alt` (`string | null`): Alternative text; null when the clinic left it empty.
    - `width` (`integer`, since 1.4.0): Width of the original in px (library files, when known), for width/height attributes without layout shift.
    - `height` (`integer`, since 1.4.0): Height of the original in px.
    - `aiGenerated` (`boolean`, since 1.4.0): The image was generated by AI: label it next to the image (e.g. in a caption).
    - `caption` (`string`, since 1.4.0): Caption to show under the image.
  - `publishedAt` (`string (date-time) | null`): Publication date, ISO 8601; null when unknown.

Example (Published case studies):

```json
{
  "caseStudies": [
    {
      "id": "cs_odbudowa",
      "slug": "pelna-odbudowa-usmiechu",
      "title": "Pełna odbudowa uśmiechu na implantach",
      "summary": "Pacjent, 58 lat, po latach unikania dentysty: sześć implantów, korony pełnoceramiczne i nowy zgryz w cztery miesiące, bez jednego dnia bez zębów.",
      "publishedAt": "2026-06-20T00:00:00.000Z",
      "path": "/realizacje/pelna-odbudowa-usmiechu",
      "image": null
    },
    {
      "id": "cs_metamorfoza",
      "slug": "metamorfoza-przed-slubem",
      "title": "Metamorfoza przed ślubem, wybielanie i bonding",
      "summary": "Panna młoda, 29 lat, sześć tygodni do ślubu: wybielanie gabinetowe i bonding brzegów siecznych, naturalny efekt bez szlifowania zębów.",
      "publishedAt": "2026-05-15T00:00:00.000Z",
      "path": "/realizacje/metamorfoza-przed-slubem",
      "image": null
    }
  ]
}
```

## Errors

| Status | code | When |
| --- | --- | --- |
| 401 |  | No Authorization header |
| 401 |  | Unknown or rotated key |
| 429 |  | Over 120 requests in this minute |

401 (No Authorization header):

```json
{
  "error": "missing Authorization: Bearer <klucz z panelu Ustawienia>"
}
```

401 (Unknown or rotated key):

```json
{
  "error": "invalid key"
}
```

429 (Over 120 requests in this minute):

```json
{
  "error": "przekroczono limit 120 zapytań/min"
}
```

## Rate limit

- 120 requests per minute per key, shared by every endpoint.

## SDK method

`client.listCaseStudies(): Promise<{ caseStudies: CaseStudySummary[] }>`
