---
title: "Get a site update"
method: GET
path: "/v1/updates/{id}"
tags: ["Content"]
---

# Get a site update

`GET /v1/updates/{id}`

## Request

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

Returns one published post, with its body blocks.

No API key required.

## Path parameters

- `id` string, required

## Response `200`

Get a site update

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` object, required: The response payload.
    - `update` SiteUpdate: A dated post about the service: what is happening with the catalogue, the platform or the company, and why. Distinct from `/v1/changelog`, which records what shipped, and from a site notice, which is one line of chrome.
      - `id` string, required: The slug, and the URL: `gunspec.io/updates/{id}`.
      - `title` string, required: The headline, as the post is listed.
      - `summary` string: One or two sentences under the headline, for a list or a feed.
      - `kind` 'catalog' | 'platform' | 'policy' | 'company' | 'incident', required: What a site update is about: the catalogue, the platform, a policy, the company, or an incident.
      - `body` UpdateBlock[], required: The post, as typed blocks in reading order rather than markup: see `UpdateBlock`.
        - `type` 'paragraph' | 'heading' | 'list' | 'quote' | 'code' | 'figure', required: The kind of block in a site update body. Each maps to a renderer on the website.
        - `text` string: The words, on a `paragraph`, `heading` or `quote`.
        - `items` string[]: The entries of a `list`.
        - `ordered` boolean: Whether a `list` is numbered.
        - `attribution` string: Who a `quote` is from.
        - `code` string: The source of a `code` block.
        - `language` string: How to highlight a `code` block.
        - `figure` UpdateFigure: The figure beside an update. Either a picture, or a character-field pattern the website draws itself: most posts have no photograph, and a named drawing is the honest alternative to a stock image. Read `kind` to tell them apart.
          - `kind` 'image' | 'glyph', required: What the asset is: `silhouette`, `render`, `photo`, `schematic`, `model`. `/v1/firearms/{id}/media/{selector}` addresses an asset by this.
          - `url` string: Where the picture is. Present when `kind` is `image`.
          - `alt` string: What the picture shows. Present when `kind` is `image`.
          - `pattern` 'impact' | 'ballistics' | 'rounds' | 'sweep' | 'waves' | 'thread' | 'lattice' | 'words': A character-field pattern an update may name in place of a photograph. The website draws it.
          - `seed` string: Seeds the drawing. The same seed always draws the same field, so a post keeps its figure between loads.
          - `words` string[]: What the `words` pattern spells. Ignored by the others.
        - `caption` string: The line under a `figure`.
      - `figure` UpdateFigure: The figure beside an update. Either a picture, or a character-field pattern the website draws itself: most posts have no photograph, and a named drawing is the honest alternative to a stock image. Read `kind` to tell them apart.
        - `kind` 'image' | 'glyph', required: What the asset is: `silhouette`, `render`, `photo`, `schematic`, `model`. `/v1/firearms/{id}/media/{selector}` addresses an asset by this.
        - `url` string: Where the picture is. Present when `kind` is `image`.
        - `alt` string: What the picture shows. Present when `kind` is `image`.
        - `pattern` 'impact' | 'ballistics' | 'rounds' | 'sweep' | 'waves' | 'thread' | 'lattice' | 'words': A character-field pattern an update may name in place of a photograph. The website draws it.
        - `seed` string: Seeds the drawing. The same seed always draws the same field, so a post keeps its figure between loads.
        - `words` string[]: What the `words` pattern spells. Ignored by the others.
      - `publishedAt` string, nullable: The day the post is dated, as `YYYY-MM-DD`. A later edit does not re-date it.
      - `pinned` integer: Held at the top of the list regardless of date.

## Other responses

- `400`: Validation error
- `404`: Resource not found
- `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)