Skip to main content
Everything here is generated from the same contract, so the spec, the Postman collection, and any client you generate stay in step with the API reference.

​
OpenAPI spec

The full OpenAPI 3.1 contract is published at /openapi.yaml. It is also listed in llms.txt for agents and indexing tools. Auth is HTTP Bearer (BearerAuth) on every operation, and the API reference playground already reads the per-operation security block.

​
Postman collection

Download the Postman collection

Collection v2.1 — 16 folders, 41 requests, bearer auth preconfigured
 To import it, open Postman and choose File → Import, then drop in the downloaded file. The collection sets bearer auth once at the collection level, so every request inherits it. Set two collection variables under Variables before your first call: Start with the Testing folder to bootstrap fixtures, then Referrals to create your first case. Quickstart walks the same sequence in cURL. You can also import /openapi.yaml directly into Postman instead of using the collection, but you will not get the folder grouping or the preset variables.

​
Generated clients

Scan does not publish npm or PyPI packages today. Generate a client from the spec with openapi-generator, or an equivalent, and pin it to a spec version you have tested against. See API versioning for what can change without notice.