Members

Manage team members, roles, and HR operations.

Get All Users

GET/api/users

Get all users in the company.

Query ParamTypeRequiredDescription
rolestringOptionalFilter by role
{ "users": [ { "id": "...", "name": "John Doe", "email": "john@example.com", "role": "employee", "avatarUrl": "...", "company": "companyId", "team": "teamId", "customRole": "Software Engineer" } ] }

Change Member Role

PATCH/api/hr/member-role

Change a member's role (HR/Admin only).

FieldTypeRequiredDescription
userIdstringRequiredUser ID
newRolestringRequiredNew role (admin, human-resource, project-manager, etc.)
{ "user": { ... updated user } }

Update Member Region

PATCH/api/hr/member-region

Update a member's region/office location.

FieldTypeRequiredDescription
userIdstringRequiredUser ID
regionLabelstringRequiredRegion label
{ "user": { ... updated user } }

Set Member Salary

POST/api/hr/member-salary/[id]

Set or update a member's salary (HR only).

FieldTypeRequiredDescription
idstringRequiredUser ID (path param)
salarynumberRequiredAnnual salary amount
currencystringOptionalCurrency code (default: INR)
{ "user": { ... updated user with salary } }

Update PF/ESIC

PATCH/api/hr/member-pf-esic/[id]

Update PF and ESIC details for a member.

FieldTypeRequiredDescription
idstringRequiredUser ID (path param)
pfNumberstringOptionalPF account number
pfDeductionAmountnumberOptionalPF deduction amount
esicNumberstringOptionalESIC number
esicDeductionAmountnumberOptionalESIC deduction amount
{ "user": { ... updated user } }

Get Member Documents

GET/api/hr/member-documents/[id]

Get documents of a specific member (HR only).

FieldTypeRequiredDescription
idstringRequiredUser ID (path param)
{ "documents": [...] }

Fire Member

POST/api/hr/fire

Terminate a member (HR/Admin only).

FieldTypeRequiredDescription
userIdstringRequiredUser ID to terminate
reasonstringOptionalTermination reason
{ "success": true }

Revoke ID Card

POST/api/hr/revoke-id-card

Revoke a member's ID card.

FieldTypeRequiredDescription
userIdstringRequiredUser ID
{ "success": true }

Update Company Policy

PATCH/api/hr/policy

Update company HR policies (HR only).

FieldTypeRequiredDescription
noticePeriodDaysnumberOptionalNotice period in days
paidLeaveDaysnumberOptionalPaid leave days per period
paidLeavePeriodstringOptionalLeave period (monthly/yearly)
minWorkHoursnumberOptionalMinimum work hours per day
{ "company": { ... updated company } }