API Reference

Both platform APIs publish an OpenAPI 3.1 document, and both are rendered here in full — every operation, every schema, with a request builder next to each one.

What these documents are

They are snapshots, taken from the running services when this site was built, and committed alongside the code. That is a deliberate trade.

A reference fetched live from the API would always be current — and would go dark whenever the API did, would depend on cross-origin permissions, and would leave every pre-rendered page empty. A committed snapshot builds offline, shows up in a diff when it changes, and carries the date it was taken.

The cost is that a snapshot can lag. A CI job re-fetches both documents on every change and fails when the committed copies no longer match the live services, so the lag is bounded by how often we build rather than by whether anyone remembered.

Trying a call

Each operation has a Test Request panel. It sends from your browser to the public endpoint, so anything that needs authentication needs a token first — see Getting started for how to obtain one. Anonymous reads work without any of that: resolution and public master data are open by design.