API Reference

Base URL

Environment	URL
Development	http://localhost:5000/api
Production	https://your-domain.com/api

Authentication

All endpoints (except Onboarding and Auth login) require a Bearer JWT in the Authorization header:

Authorization: Bearer <token>

Obtain a token via POST /api/auth/login.

Common Response Formats

Success — Paginated List

{
  "items": [...],
  "totalCount": 42,
  "page": 1,
  "pageSize": 10
}

Error — ProblemDetails

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-abc123..."
}

Common HTTP Status Codes

Code	Meaning
200 OK	Request succeeded
201 Created	Resource created — Location header points to new resource
204 No Content	Delete/action succeeded with no response body
400 Bad Request	Validation error — check request body
401 Unauthorized	Missing or invalid JWT
403 Forbidden	Valid JWT but missing required permission
404 Not Found	Resource does not exist (or was soft-deleted)

Interactive API Explorer

The live Scalar UI is available while the API is running:

👉 http://localhost:5000/scalar/v1

All endpoints, request bodies, and response schemas are documented there with Try-It support.