Skip to main content

​
Authentication & scope

Requires workflows-read and workspace admin access. Versions must belong to the workflow in the URL.

​
Reading a changelog

Use view=changelog&after_version=12&through_version=18 to read versions 13 through 18, including drafts. Debug versions are excluded. change_notes contains the full current Markdown; definitions are omitted. Alternatively, use since=2026-09-01T00:00:00Z to select by version creation time. A date without a time means midnight UTC. Do not combine since and after_version. This does not select by publication or notes-edit time. The response contains data, pagination meta/links, and a resolved range. Follow every page; preserve range.through_version as the upper bound to exclude new versions created during export. The default page size is 25 and the maximum is 100. A null note means the version has no explanation; do not silently omit it from a summary. Use view=history for descending order and short excerpts in a UI. Without view, the existing array of complete snapshots is returned; include_debug=1 applies only to that default mode.

​
Errors

  • 403: insufficient permissions.
  • 404: workflow not found in the route workspace.
  • 422: invalid dates, page size or version bounds; bounds must identify visible versions in this workflow. through_version=0 preserves an empty snapshot.
A range of notes describes the chronology, not necessarily the net difference between definitions: inspect base-version and restoration metadata when summarizing.