REST API

Published releases, over HTTP

Use ReleaseView's versioned JSON API to list, search, and fetch a project's public release notes. It is designed for websites, scripts, support tools, and custom integrations.

PublicNo API keyPublished notes only

Quickstart

Replace <slug> with the project slug shown under Project → Settings.

Terminal
curl "https://www.releaseview.com/api/v1/projects/<slug>/releases"

Requests require no authorization header. Only notes already published on the project's public changelog are returned.

Endpoints

MethodPathPurpose
GET/releasesList releases by latest linked commit, newest first.
GET/releases?q=dark+modeSearch versions, titles, summaries, and section text.
GET/releases/latestFetch the published release with the newest linked commit.
GET/releases/<version>Fetch one exact published version.

List and search results are ordered by the newest linked commit in each release. Releases without linked commits appear last. Publication time breaks ties. The /releases/latest endpoint uses the same order.

Search request
curl --get "https://www.releaseview.com/api/v1/projects/<slug>/releases" \
  --data-urlencode "q=dark mode"

Response schema

List and search requests return releases as an array. The latest and version routes return the same object under release.

200 · application/json
{
  "project": {
    "name": "Acme",
    "logo_url": "https://example.com/logo.png",
    "slug": "acme"
  },
  "release": {
    "version": "v2.1.0",
    "title": "Dark mode & faster sync",
    "summary": "A more comfortable interface and quicker updates.",
    "sections": [
      { "heading": "What's New", "items": ["Dark mode", "Faster sync"] }
    ],
    "commit_dates": ["2026-07-24T16:00:00Z", "2026-07-23T09:00:00Z"],
    "published_at": "2026-07-25T21:28:02Z",
    "url": "https://www.releaseview.com/project/acme/v2.1.0"
  }
}

A project with no published notes returns an empty releases array from the list endpoint. The commit_dates array contains stored timestamps for linked commits, newest first, and is empty when none are recorded. The published_at field records when the note went public. Nullable fields may be returned as null.

Existing requests receive commit_dates automatically. Use its first item for the newest linked commit and handle an empty array. If your client validates an exact response shape, add commit_dates as an array of strings.

Errors

StatusBodyWhen
404{ "error": "Project not found" }Unknown slug on the list route.
404{ "error": "No published releases found" }No result for the latest route.
404{ "error": "Release not found" }Unknown or unpublished version.
500{ "error": "Something went wrong" }Unexpected server or database failure.

Caching & limits

Successful responses include Cache-Control: public, s-maxage=60, stale-while-revalidate=300. Shared caches may serve a response for 60 seconds and may serve stale content for up to five minutes while refreshing it.

List and search responses are paginated: use limit (1–100, default 50) and offset (default 0). Follow pagination.nextOffset while pagination.hasMore is true. Search with q (up to 200 characters). Avoid aggressive polling; account access is checked on every request. The API exposes published release notes and their linked commit timestamps. Commit contents, drafts, subscribers, and project settings are private.