Skip to main content

​
Base URL

http://localhost:3001/api/v1

​
Authentication

Cookie-based JWT authentication with email/password. 
curl -X POST http://localhost:3001/api/v1/auth/signin \
  -H "Content-Type: application/json" \
  -c cookies.txt \
  -d '{"email":"admin@example.com","password":"password123"}'

​
Response Format

Success: 
{
  "success": true,
  "data": { ... }
}
Error: 
{
  "success": false,
  "error": {
    "message": "Error message",
    "code": "ERROR_CODE"
  }
}

​
Features

  • User Management: Complete CRUD operations for citizens and residents
  • Admin Management: Administrative user management with role-based access
  • Building Management: Hierarchical management of sectors, buildings, floors, units, and blocks
  • Ticket System: Comprehensive support ticket management with technician assignment
  • Permission System: Granular role-based access control with customizable permissions
  • File Management: Secure image upload and document management
  • Address Management: Geographic and address data management
  • Vehicle Management: Vehicle registration and tracking
  • Family Management: Family member associations and management

​
Rate Limiting

  • Default: 100 requests/minute
  • Short: 3 requests/second
  • Medium: 20 requests/10 seconds

​
Next Steps