FlowZen API Documentation
Complete API reference for integrating with FlowZen mobile application. Build custom clients and automate workflows.
Base URL
https://flowzen-azure.vercel.app/api
For using the api, use
https://flowzen-azure.vercel.app
Quick Start
FlowZen API uses standard REST conventions. All responses are JSON.
Base URL: All endpoints are relative to /api
Mobile App Authentication
For Android/iOS apps, FlowZen provides two authentication flows:
Existing Users — Mobile Login
// Step 1: Login
POST /api/auth/mobile-login
{
"email": "user@example.com",
"password": "your-password"
}
// Response:
{
"token": "eyJhbGciOiJIUzI1NiIs...",
"user": { ... }
}
// Step 2: Use token in all subsequent requests
GET /api/profile
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
New Users — Register + Verify OTP
// Step 1: Register
POST /api/auth/register
{
"name": "John Doe",
"email": "john@example.com",
"password": "password123"
}
// Step 2: Verify OTP (returns token)
POST /api/auth/verify-otp
{
"email": "john@example.com",
"otp": "123456"
}
// Response:
{
"ok": true,
"token": "eyJhbGciOiJIUzI1NiIs...",
"user": { ... }
}
// Step 3: Use token in all subsequent requests
GET /api/profile
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Token Expiry: Tokens are valid for 1 year. Store securely on device.
Modules
Dashboard
Company overview and quick stats
Profile
User profile management
Onboarding
Company and team joining
Members
Team member management
Visitors
Visitor pass management
Security
Entry logs and security
Documents
Document management
Approvals
Request approvals
Messages
Internal messaging
Finance
Salary and finance management
Attendance
Check-in/out and leaves
Calendar
Events and meetings
Notifications
User notifications
Recruitment Module
Response Format
{
"success": true,
"data": { ... }
}
Error Handling
Errors return appropriate HTTP status codes with a message:
{
"error": "Error message description"
}