Content

Optional. Without a key this endpoint answers under the public policy; a key raises your limits and unlocks plan-gated fields. Authorization: Bearer <key> is accepted in its place.

Page number, from 1 to 10,000

Range

1 – 10000

Example

1

Items per page (max 100)

Range

1 – 100

Example

20

Filter by entry category

Accepts

featureimprovementbugfixdatabreaking

Max length

60

One page of results

Slug of the entry, taken from the file it was authored in.

Entry headline.

Entry body, in Markdown.

What kind of change: feature, improvement, bugfix, data, breaking.

When it was published, ISO 8601.

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.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

When it last changed, ISO 8601.

Current page number

Items per page

Total matching records (Builder and above)

Optional. Without a key this endpoint answers under the public policy; a key raises your limits and unlocks plan-gated fields. Authorization: Bearer <key> is accepted in its place.

Changelog entry id

Example

039-3d-models-line-art-and-a-phantom-firearm

The response payload

Slug of the entry, taken from the file it was authored in.

Entry headline.

Entry body, in Markdown.

What kind of change: feature, improvement, bugfix, data, breaking.

When it was published, ISO 8601.

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.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

When it last changed, ISO 8601.

Optional. Without a key this endpoint answers under the public policy; a key raises your limits and unlocks plan-gated fields. Authorization: Bearer <key> is accepted in its place.

Page number, from 1 to 10,000

Range

1 – 10000

Example

1

Items per page (max 100)

Range

1 – 100

Example

20

Filter by post category

Max length

60

Example

guides

A published post. Both endpoints serve the stored row; body is markdown.

Opaque post id. A string, not a number: posts are keyed like every other authored record here.

URL-safe slug, and what /v1/blog/{slug} addresses.

Post headline.

One-line description, for a card or a feed. Null where the author wrote none.

The post itself, as markdown.

Path of the hero image on the assets CDN, or null. Prefix it with the assets host to fetch.

Editorial category, e.g. guides. Null where the post has none.

Always published on these endpoints: a draft is not served publicly.

When the post was published, which is what the list orders by. Null on a post never given a date.

When the post was first written, YYYY-MM-DD HH:MM:SS in UTC. Not the publication date: postedAt is.

When the post was last edited, YYYY-MM-DD HH:MM:SS in UTC.

Current page number

Items per page

Total matching records (Builder and above)

Optional. Without a key this endpoint answers under the public policy; a key raises your limits and unlocks plan-gated fields. Authorization: Bearer <key> is accepted in its place.

Blog post slug

Accepts

a lowercase slug: letters, digits and hyphens

Example

what-is-firearms-specification-api

The response payload.

A published post. Both endpoints serve the stored row; body is markdown.

Opaque post id. A string, not a number: posts are keyed like every other authored record here.

URL-safe slug, and what /v1/blog/{slug} addresses.

Post headline.

One-line description, for a card or a feed. Null where the author wrote none.

The post itself, as markdown.

Path of the hero image on the assets CDN, or null. Prefix it with the assets host to fetch.

Editorial category, e.g. guides. Null where the post has none.

Always published on these endpoints: a draft is not served publicly.

When the post was published, which is what the list orders by. Null on a post never given a date.

When the post was first written, YYYY-MM-DD HH:MM:SS in UTC. Not the publication date: postedAt is.

When the post was last edited, YYYY-MM-DD HH:MM:SS in UTC.

Optional. Without a key this endpoint answers under the public policy; a key raises your limits and unlocks plan-gated fields. Authorization: Bearer <key> is accepted in its place.

The response payload.

Published notices inside their display window, best first: highest priority, then newest.

Row id of the notice. The website keys its dismissal on this, so a new notice is seen even by a reader who dismissed the last one.

Short label shown before the message.

The sentence shown in the banner.

A second line, shown under the highlight where one is set.

How prominently a site notice is shown.

Text of the call to action, or null when the banner has none.

Where the call to action goes.

Higher sorts first. Ties break on newest.

When the notice becomes visible. Null means immediately.

When it stops being shown. This is why notices are rows rather than copy: an end date is the only version of "take this down later" that does not rely on somebody remembering.