Skip to main content
GET
/
changelog
/
{public_slug}
Get Public Changelog
curl --request GET \
  --url https://api.example.com/changelog/{public_slug}
Retrieves a single published changelog by its public slug. This endpoint does not require authentication.

​
Path Parameters

​
public_slug
string
required
The unique public slug of the changelog.

​
Request

curl -X GET "https://app.shipstar.ai/api/v1/changelog/my-product-changelog-march-2025"

​
Response

Returns the changelog object with its full content.

​
Example Response

200
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "slug": "my-product-changelog-march-2025",
  "content": "{\"title\": \"March 2025 Changelog\", \"entries\": [{\"category\": \"New Features\", \"title\": \"Dashboard redesign\", \"description\": \"Completely rebuilt dashboard with new analytics views.\"}]}",
  "period_start": "2025-03-01T00:00:00Z",
  "period_end": "2025-03-31T23:59:59Z",
  "published_at": "2025-04-01T10:00:00Z",
  "created_at": "2025-03-31T15:00:00Z"
}

​
Errors

StatusDescription
404Changelog not found or not published
422Invalid slug format