7. Changelog

What changed in the API and when, readable by your integration.

Read first: Changelog.

Base URL https://api.axiomscript.com. Every request is signed; see Authentication and signing.

GET/changelogWhat changed in this API, newest first

What changed in this API, newest first

GET/api/inbound/{partnerSlug}/changelog

The same changelog shown in the developer portal, machine-readable, so an integration can check for changes without anyone having to be told. Entries are ordered newest first and each names the endpoints it affects. breaking: true means an integration that worked before that date can stop working, and those entries carry an action saying what to change. latest is the date of the newest entry; several entries can share a date, so compare the entries themselves (date and title) with what you stored to find new ones.

Parameters

partnerSlugstringpathrequired

The partner's Axiom-issued slug (e.g. acme-health).

Responses

Status	Meaning
200	The changelog, newest first
401	Missing, expired, or invalid HMAC signature / timestamp
423	partner_inactive or tenant_suspended. Your partner account is deactivated or suspended, so no request will be served until it is reinstated.
429	Per-partner rate limit exceeded

Response fields (200)

oktruerequired

 

lateststring (date)required

The date of the most recent entry.

changelogarray of objectrequired

 

changelog[].datestring (date)required

 

changelog[].titlestringrequired

 

changelog[].detailstringrequired

 

changelog[].breakingbooleanrequired

True when an integration that worked before this date can stop working.

changelog[].actionstringoptional

Present on every breaking entry. What you need to change.

changelog[].endpointsarray of stringoptional

 

changelog[].printegerrequired

The change that shipped it, so any claim here is traceable.

Request

GET /api/inbound/acme-health/changelog
Host: api.axiomscript.com
X-Axiom-Timestamp: 1767225600
X-Axiom-Signature: sha256=<hex>

Response 200

{
  "ok": true,
  "latest": "2026-10-23",
  "changelog": [
    {
      "date": "2026-10-23",
      "title": "Example: a new read-only endpoint",
      "detail": "New: `GET /api/inbound/:partnerSlug/example` returns ... (an illustrative entry, not a real change).",
      "summary": "You can now read ... (illustrative).",
      "breaking": false,
      "endpoints": [
        "GET /api/inbound/:partnerSlug/example"
      ],
      "pr": 1000
    }
  ]
}