Changelog API reference
Changelog endpoints of the Quackback REST API: paths, parameters, request fields and responses.
This is the reference for the Changelog endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.
All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.
Endpoints
GET /changelog: List changelog entriesPOST /changelog: Create a changelog entryGET /changelog/{entryId}: Get a changelog entryPATCH /changelog/{entryId}: Update a changelog entryDELETE /changelog/{entryId}: Delete a changelog entry
List changelog entries
GET /api/v1/changelog
Returns changelog entries with optional filtering by published status
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| query | string ( | No | Filter by published status |
| query | string | No | Pagination cursor for next page |
| query | integer | No | Items per page |
Response 200: returns id, title, content, publishedAt, displayDate, createdAt, updatedAt, linkedPosts.
Create a changelog entry
POST /api/v1/changelog
Create a new changelog entry
Request body
Field | Type | Required | Description |
|---|---|---|---|
| string | Yes | Entry title |
| string | Yes | Entry content (supports markdown) |
| string | No | Publish date (omit to save as draft) |
| array of string | No | Post IDs to link to this entry. On update, replaces the existing set; an empty array unlinks all. |
Response 201: returns id, title, content, publishedAt, displayDate, createdAt, updatedAt, linkedPosts.
Get a changelog entry
GET /api/v1/changelog/{entryId}
Get a single changelog entry by ID
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Changelog entry ID |
Response 200: returns id, title, content, publishedAt, displayDate, createdAt, updatedAt, linkedPosts.
Update a changelog entry
PATCH /api/v1/changelog/{entryId}
Update an existing changelog entry
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Changelog entry ID |
Request body
Field | Type | Required | Description |
|---|---|---|---|
| string | No | |
| string | No | |
| string, nullable | No | |
| string, nullable | No | |
| array of string | No | Post IDs to link to this entry. On update, replaces the existing set; an empty array unlinks all. |
Response 200: returns id, title, content, publishedAt, displayDate, createdAt, updatedAt, linkedPosts.
Delete a changelog entry
DELETE /api/v1/changelog/{entryId}
Delete a changelog entry by ID
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Changelog entry ID |
Was this helpful?
Your feedback shapes what we write next.