1. Overview
SQWARE uses an internal-first JSON API for the web application. Some routes are suitable for browser use and public pages, while others require authentication and are intended for owner workflows, billing flows, or operational tasks.
Important: Treat undocumented or private routes as subject to change. If you need partner or integration access, start in the Help Center.
2. Authentication
Authenticated requests use a bearer token in the Authorization header:
Authorization: Bearer <token>- Tokens are issued by the account auth flow and used for account, listing, hosting, and other owner features.
- The web app also sends an
X-SQWARE-Anonymous-Idheader to support analytics and basic request correlation.
3. Request and response conventions
- Requests and responses are JSON unless explicitly stated otherwise.
- Successful responses return JSON objects; error responses typically return an
errorfield and an appropriate HTTP status. - Common statuses include
200,201,202,400,401,404, and502depending on the route.
4. Current endpoint groups
Health
/api/health provides a simple backend health response.
Auth
/api/auth/* covers registration, login, logout, and session/user lookups for signed-in users.
Server discovery and listings
Server-related routes power public discovery, server status lookups, listing submission flows, and owner-managed listing updates.
Hosting and promotions
Hosting routes support plan discovery, draft orders, and provider checkout setup. Promotions routes support promoted listing workflows and related owner actions.
Jobs and plugins
Jobs and plugin-related routes support marketplace-style or catalog-style product features exposed by the SQWARE frontend.
Analytics
Analytics ingestion endpoints accept event payloads used by the first-party site. They are not an invitation to flood the platform with synthetic traffic, because chaos is not a valid analytics methodology.
5. Usage expectations, limits, and abuse prevention
Use of the API is subject to the Acceptable Use Policy and platform terms. SQWARE may add validation, moderation, authentication requirements, throttling, or other restrictions at any time to protect platform integrity, reduce abuse, and keep the service available.
6. Support and integration questions
If you need clarification on API behavior, current support status, or possible integration access, start at the Help Center or the official SQWARE Discord.