Skip to content

Reference

OpenAPI

The whole API as an OpenAPI 3.1 document — endpoints, parameters, schemas, errors and webhook payloads. It's generated from the same registry as these docs, so the two can't disagree.

The spec

GEThttps://passcode.sh/api/v1/openapi.json
Endpoints
16
Schemas
13
Webhook events
5
Version
OpenAPI 3.1.0 · API 1.0.0
Auth
No key needed to download it. It’s the only API resource served with CORS (Access-Control-Allow-Origin: *), so browser-based tools can load it.
Webhooks
Event payloads are under the top-level webhooks key.

Use it

  • Postman or Insomnia: import the URL above to get a ready-made collection. Set the bearer token to your API key.
  • Swagger UI, Redoc, Scalar: point them at the URL.
  • Contract tests: validate responses in your test suite against the schemas.

Generate a client

Any OpenAPI 3.1 generator works. Two common ones:

Terminal
# TypeScript types for fetch-based code
npx openapi-typescript https://passcode.sh/api/v1/openapi.json -o passcode.d.ts

# A full Python client
npx @openapitools/openapi-generator-cli generate \
  -i https://passcode.sh/api/v1/openapi.json -g python -o ./passcode-client

Generated clients are convenient, but the API is small enough that plain fetch or requests works well too — see the Quickstart.