Praxi API Reference
The Praxi API provides programmatic access to practice management features including scheduling, client management, billing, and more.
Authentication
All API requests require authentication via JWT tokens obtained from the Praxi authentication service.
curl -X POST https://api.praxi.au/api/auth/login \
-H "Content-Type: application/json" \
-d '{"email": "user@practice.com", "password": "..."}'
Base URL
https://api.praxi.au/api
Rate Limiting
API requests are rate-limited to protect service quality:
| Window | Limit |
|---|---|
| Per second | 200 requests |
| Per 10 seconds | 1,500 requests |
| Per minute | 8,000 requests |
Response Format
All responses are JSON. Successful responses return the data directly. Error
responses include a message and statusCode.
Interactive Playground
When the OpenAPI spec is generated, interactive "Try it" endpoints will appear
below each API section. Run pnpm export:openapi with the API server running to
populate the reference.
Available Endpoints
API documentation is auto-generated from the NestJS Swagger spec. Categories include:
- Scheduling — Appointments, calendar, availability
- Clients — Client records, intake, referrals
- Clinical Notes — Notes, templates, signing
- Billing — Invoices, payments, Medicare claiming
- Communication — Messaging, notifications, email
- AI — Agent interactions, document generation
- Settings — Organisation and user configuration