Dashboard

The Dashboard module provides company overview data and quick stats for the mobile app home screen.

Get Company Info

GET/api/company

Get current user's company details.

Response

{ "company": { "id": "...", "name": "Acme Corp", "status": "active", "joinCode": "ABC123", "primaryColor": "#6366f1", "icon": "...", "address": "...", "members": ["userId1", "userId2"], "noticePeriodDays": 30, "paidLeaveDays": 12, "wfhDays": 5, "minWorkHours": 8 } }

Get Users

GET/api/users

Get all users in the company.

Query ParamTypeRequiredDescription
rolestringOptionalFilter by role (admin, human-resource, etc.)

Response

{ "users": [ { "id": "...", "name": "John Doe", "email": "john@example.com", "role": "employee", "avatarUrl": "...", "company": "companyId" } ] }

Get Company Admins

GET/api/company/admins

Get all company administrators.

{ "admins": [ { "id": "...", "name": "Admin User", "email": "admin@example.com", "role": "admin" } ] }

Get Company HRs

GET/api/company/hrs

Get all HR members in the company.

{ "hrs": [ { "id": "...", "name": "HR User", "email": "hr@example.com", "role": "human-resource" } ] }

Get Member Birthdays

GET/api/company/members/birthdays

Get upcoming member birthdays.

{ "birthdays": [ { "id": "...", "name": "John", "dob": "1990-05-15", "avatarUrl": "..." } ] }