---
title: "List changelog entries"
method: GET
path: "/v1/changelog"
tags: ["Content"]
---

# List changelog entries

`GET /v1/changelog`

## Request

- Base URL: `https://api.gunspec.io`
- URL: `https://api.gunspec.io/v1/changelog`
- Auth: one of:
  - none
  - API key in header `X-API-Key`
  - HTTP bearer

Returns published product changelog entries, newest first. Also available as RSS at `/changelog.xml`.

No API key required.

## Query parameters

- `page` integer
- `per_page` integer
- `category` 'feature' | 'improvement' | 'bugfix' | 'data' | 'breaking'

## Response `200`

List changelog entries

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` ChangelogEntry[], required: One page of results. Use `pagination` to walk the rest.
    - `id` string, required: Slug of the entry, taken from the file it was authored in.
    - `title` string, required: Entry headline.
    - `body` string: Entry body, in Markdown.
    - `category` string, nullable: What kind of change: `feature`, `improvement`, `bugfix`, `data`, `breaking`.
    - `publishedAt` string: When it was published, ISO 8601.
    - `published` integer: Integer flag, `1` when the entry is live. The public feed only returns published entries, so this is `1` on every row a consumer sees.
    - `createdAt` string: When the record was first added, `YYYY-MM-DD HH:MM:SS` in UTC.
    - `updatedAt` string: When it last changed, ISO 8601.
  - `pagination` Pagination: Page-size is reported under both `per_page` (matching the request parameter) and `limit` (retained for existing integrations). They always carry the same value. `total` and `totalPages` are omitted for Explorer and anonymous callers.
    - `page` integer, required: The page this response is, 1-based.
    - `per_page` integer, required: Page size. Same value as `limit`.
    - `limit` integer, required: Page size. Alias of `per_page`.
    - `total` integer: Total records matching the query across every page.
    - `totalPages` integer: How many pages the result set spans at the current `per_page`.

## Other responses

- `400`: Validation error
- `429`: A limit was reached. `RATE_LIMITED` is the per-minute limit: wait `Retry-After` seconds (a minute) and retry. `DAILY_CAP_EXCEEDED` is the plan's daily limit, per key: nothing will be served until the counters return to zero at midnight UTC. `MONTHLY_CAP_EXCEEDED` is the plan's monthly allowance, for the whole account: nothing will be served until midnight UTC on the first of next month, or until the plan changes. For both, `Retry-After` is the seconds until then and `error.resetsAt` says when as an instant. Calls made after a refusal are refused too and do not spend the month, and a free key that keeps calling is paused, so stop at the first one and resume at the reset.
- `500`: Internal server error

---

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