API Reference
The API is documented automatically via drf-spectacular (OpenAPI 3).
Accessing the Schema
When running locally:
| URL | Description |
|---|---|
/api/schema/ | Raw OpenAPI YAML/JSON |
/api/schema/swagger-ui/ | Swagger UI |
/api/schema/redoc/ | ReDoc UI |
Auth Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /api/auth/login/ | Obtain JWT tokens |
| POST | /api/auth/logout/ | Invalidate refresh token |
| POST | /api/auth/token/refresh/ | Refresh access token |
| POST | /api/auth/registration/ | Register new user |
| POST | /api/auth/password/reset/ | Trigger password reset email |
Key Resource Endpoints
All endpoints are prefixed with /api/ and require a valid JWT Authorization: Bearer <token> header unless noted.
| Resource | Base path |
|---|---|
| Users | /api/users/ |
| Organizations | /api/organizations/ |
| Referrals | /api/referrals/ |
| Applications | /api/applications/ |
| Forms | /api/forms/ |
| Job Forms | /api/job-forms/ |
| Competency Tests | /api/competency-tests/ |
| Competency Checklists | /api/competency-checklists/ |
| Compliance Documents | /api/compliance-documents/ |
| Work Schedules | /api/work-schedules/ |
| Notifications | /api/notifications/ |
| Messages | /api/messages/ |
| Grievances | /api/grievances/ |
| Audit Logs | /api/audit-logs/ |
Pagination & Filtering
- Default pagination: page-based (
?page=1&page_size=20) - Filtering:
django-filteron most list endpoints (e.g.?status=PENDING&organization=1) - Ordering:
?ordering=-created_at