API Reference
The Zander API is the central hub that all the other pieces talk to - your Minecraft plugins send it session and chat data, the Discord bot uses it for punishments and events, and the web dashboard uses it for everything from announcements to voting. This page is written for developers building an integration or troubleshooting a connection problem; if you just want to configure or use Zander day-to-day, you likely don't need this page.
Base URL
https://<your-site>/api
The base URL is set by siteAddress in your .env file.
Response Format
All API endpoints return JSON in the following structure:
Success:
{
"success": true,
"data": { ... }
}
Error:
{
"success": false,
"message": "Error description"
}
Some endpoints return additional pagination metadata (e.g. page, limit) alongside data.
HTTP Status Codes
| Code | Meaning |
|---|---|
200 | Success |
400 | Bad request - missing or invalid parameters |
401 | Unauthorised - missing or invalid API token |
403 | Forbidden - feature disabled or permission denied |
404 | Not found |
500 | Internal server error |
Authentication
See Authentication for details on how to authenticate API requests.
Where to find an endpoint
- Endpoints - the full list of endpoint groups with their base paths, one line each, linking straight into the interactive reference.
- Interactive API Reference - the detailed reference itself: every endpoint's method, path, parameters, request/response schema, and auth requirement, generated from the OpenAPI spec and grouped by feature (~200 endpoints across 26 groups).