API Reference
VSQRD HTTP API overview — base URL, auth, pagination, errors.
Browse the VSQRD HTTP API by resource in the sidebar. Endpoint pages are generated from the committed OpenAPI snapshot during the API docs sync.
Base URL
All endpoints are served from https://vsqrd.com.
Authentication
Most endpoints require a Bearer token:
Authorization: Bearer <token>See Authentication for how to obtain and verify one.
Pagination, sorting, and filters
List-style endpoints commonly accept:
| Param | Notes |
|---|---|
page | 1-based page index |
page_size | Page size (endpoint-specific defaults/limits) |
sort_by | Field to sort by (enum per resource) |
sort_order | asc or desc |
Exact names and enums are listed on each endpoint under Parameters.
Errors
Validation failures return 422 with:
{
"detail": [
{
"loc": ["body", "field_name"],
"msg": "Field required",
"type": "missing"
}
]
}Sections
Use the sidebar for Overview, Authentication, Models, and Status, then the resource sections. Each resource opens a hub listing every endpoint available in that domain and environment.
See API Status for the OpenAPI changelog and the latest smoke-check summary (pnpm check:api): 401 = pass (route alive), 5xx = fail.