API reference

What this reference covers

This page is generated from the service's own schema, so for the operations it contains it is the most reliable description available — including which parent scoping each operation uses. Follow each operation individually rather than assuming a universal rule.

The raw document behind it is openapi.json — download it if you would rather read it directly, feed it to a generator, or load it into your own client.

The schema covers organization creation and retrieval, the audit feeds, storage-backend (BYOSA) management, and SAML SSO configuration. It does not cover internal operator tooling — see Feature availability. The audit CSV export is not here either, because it is a web-app download built from the audit feeds rather than an API operation.

For rules that apply across every operation, read API conventions, Authentication, and Errors.