Get a Changelog
A guide on how to query a changelog from the Chxngelog API.
Endpoint
GET https://api.chxngelog.com/changelogs/get-a-changelog?changelogId=YOUR_CHANGELOG_ID
Query Parameters
changelogId
(required): The unique identifier of the changelog you are queryingincludeDrafts
(optional): Include drafts in the response. Default isfalse
majorVersionsOnly
(optional): Include only major versions in the response. Default isfalse
sortOrder
(optional): The order to sort the changelog entries. Default isdesc
for descending,asc
for ascending.
Example Response
{ "changelogs": [ { "id": 1, "name": "Example Changelog", "slug": "example-changelog", "date": "2023-06-13", "description": "Initial release.", "changes": [ "Added new feature X.", "Improved performance for Y." ], "team": { "name": "Example Team", "teamSlug": "example-team" }, "versions": [ { "versionId": 1, "name": "Version One", "versionNo": "v1.0", "releaseDate": "10-10-23", "changes": [ { "id": 1, "description": "A change", "type": "ADDED" } ] } ] } ]}