---
title: "List release notes"
method: GET
path: "/api/v1/whats-new"
tags: ["Release notes"]
---

# List release notes

`GET /api/v1/whats-new`

## Request

- Base URL: `https://your-deployment.example.com`
- URL: `https://your-deployment.example.com/api/v1/whats-new`
- Auth: none required

Lists published release notes, newest first. Public: no credentials are needed, and the response is cacheable for up to about 15 minutes (5 fresh plus 10 stale-while-revalidate), so a newly published or withdrawn note can take that long to show. A deployment that proxies an upstream feed stacks its own caching on the upstream's, so there it can take about 31 minutes. Cursor-paginated (see the pagination convention): pass `next_cursor` back as `cursor` until it is `null`. Rate limited per client IP.

## Query parameters

- `limit` integer
- `cursor` string

## Response `200`

One page of published release notes, newest first by `published_at`.

- ListWhatsNewResponse200
  - `data` object[], required
    - `id` string, required
    - `release_tag` string, required
    - `headline` string, required
    - `summary` string, required
    - `published_at` string, required
    - `items` object[], required
      - `category` 'new' | 'improved' | 'fixed', required
      - `text` string, required
      - `importance` integer, required
  - `next_cursor` string, nullable, required

## Other responses

- `405`: The path does not serve this HTTP method.
- `422`: `limit` is out of range, or `cursor` is malformed or was issued by a different endpoint. A cursor is opaque: pass back exactly the `next_cursor` you were given. On a deployment that proxies an upstream feed, a cursor issued by that upstream which can no longer be served there ends the list (200 with empty `data`) rather than returning 422.
- `429`: Per-IP rate limit exceeded.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/bike4mind/apis/bike4mind-api.md) · [All operations](https://skmtc.dev/bike4mind/apis/bike4mind-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bike4mind/apis/bike4mind-api/revisions/0de0bdb0d113?raw)