Rest API
API Routes
2/19/2026
Comprehensive list of REST API endpoints for the Mobile App Boilerplate.
Authentication
Public and protected routes for managing user identity and sessions.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
POST | /auth/login | Log in with email and password | No |
POST | /auth/register | Create a new user account | No |
POST | /auth/google | Social login via Google ID token | No |
POST | /auth/forgot-password | Send password reset link | No |
POST | /auth/reset-password | Reset password using token | No |
POST | /auth/logout | Revoke current access token | Yes |
GET | /auth/me | Fetch authenticated user details | Yes |
PUT | /auth/update-password | Change current user password | Yes |
POST | /auth/fcm-token | Update Firebase Cloud Messaging token | Yes |
Security & Sessions
Endpoints for monitoring account security and managing active devices.
| Method | Endpoint | Description | Abilities |
|---|---|---|---|
GET | /security/authlogs | View account authentication history | security:read |
GET | /security/sessions | List active device sessions | security:read |
DELETE | /security/sessions/{id} | Revoke a specific session | security:update |
DELETE | /security/sessions | Revoke all other sessions | security:update |
DELETE | /security/delete-account | Permanently delete account | user:delete |
User Management
| Method | Endpoint | Description | Abilities |
|---|---|---|---|
PUT | /users/{uuid} | Update user profile information | user:update |
Notifications
Endpoints for managing user notification history and preferences.
| Method | Endpoint | Description | Abilities |
|---|---|---|---|
GET | /notifications | List user notification history | notifications:read |
PUT | /notifications/read-all | Mark all notifications as read | notifications:update |
PUT | /notifications/{id}/read | Mark a specific notification as read | notifications:update |
DELETE | /notifications | Delete all notification history | notifications:delete |
GET | /notifications/preferences | Fetch notification settings | preferences:read |
PUT | /notifications/preferences | Update notification settings | preferences:update |
Help Center
Public and protected resources for support and feedback.
| Method | Endpoint | Description | Auth |
|---|---|---|---|
GET | /help-center | List all help center items | Yes |
GET | /help-center/faqs | List all FAQs | Yes |
GET | /help-center/faqs/popular | List most viewed FAQs | Yes |
GET | /help-center/contacts | List available contact methods | Yes |
GET | /help-center/operating-hours | List business operating hours | Yes |
POST | /help-center/feedback | Submit user feedback | Yes |
Preferences
General user preferences like language and theme.
| Method | Endpoint | Description | Abilities |
|---|---|---|---|
GET | /preferences | Fetch user app preferences | preferences:read |
PUT | /preferences | Update app preferences | preferences:update |
Admin Operations
Restricted endpoints for administrative tasks. These require the super_admin role.
| Method | Endpoint | Description | Role |
|---|---|---|---|
POST | /notifications/send | Send a push notification to a specific user | super_admin |
POST | /notifications/broadcast | Broadcast a push notification to all users | super_admin |