API Reference | QwikLive Onboarding

📌

Conventions

All paths are versioned under /v1. Successful responses use the envelope { "data": ..., "success": true, "message": "...", "timestamp": "..." }. Protected endpoints require Authorization: Bearer <JWT_TOKEN>. Send x-correlation-id on every request for tracing. For shared error semantics see Error Handling.

Specification & downloads

Use these artifacts to generate clients, mock servers or render the spec in your own viewer (Swagger UI, Redocly, Stoplight).

📄

OpenAPI 3.0 (YAML)

Download openapi.yaml — import into Swagger UI, Redocly or Postman.

🧪

Postman collection

Download the sanitized collection — secrets removed.

💡

Render the spec in any viewer

Point an OpenAPI viewer at the downloaded openapi.yaml, or run one locally:

bash

# Redocly (Node, MIT/Apache-licensed)
npx @redocly/cli preview-docs openapi/openapi.yaml

# Swagger UI (Docker, Apache-2.0)
docker run -p 8080:8080 -e SWAGGER_JSON=/spec/openapi.yaml \
  -v "$PWD/openapi:/spec" swaggerapi/swagger-ui

Endpoints

⚙️

Interactive reference is generated on build

The full interactive endpoint reference (parameters, request/response schema, response codes per endpoint) is generated from Swagger/OnBoarding-Backend.json + assets/api-enrichment.js by npm run build:api, then rendered here by apiref.js — the same engine as the QwikLive EAPI docs. Until the first build runs, use the downloadable spec above in any OpenAPI viewer.