Skip to Content
API ReferenceEmployees

Employees API

Manage employee records in the tenant database.

Endpoints

GET /api/employees

List all employees with optional filtering.

Query Parameters:

ParameterTypeDescription
searchstringSearch by name, ID, email, or phone
departmentstringFilter by department
statusstringFilter by status (active, inactive, etc.)
pagenumberPage number for pagination
limitnumberResults per page

POST /api/employees

Create a new employee record.

Request Body: Employee object with required fields (first_name, last_name, email, department, designation, joining_date).

GET /api/employees/{employeeId}

Get a single employee’s complete profile.

PUT /api/employees/{employeeId}

Update an employee record.

DELETE /api/employees/{employeeId}

Delete an employee record (soft delete).

GET /api/employees/{employeeId}/documents

List documents for a specific employee.

POST /api/employees/{employeeId}/documents

Upload a document for an employee.

GET /api/employees/{employeeId}/activity-log

View the change history for an employee record.

POST /api/employees/{employeeId}/resignation

Submit a resignation for an employee (initiates exit process).

Last updated on