Logo

Dyzo API

v2.0.0

Getting Started

Getting StartedAuthentication

Company Setup

Company CreationEmployee Invitation

Login & Sessions

Login MethodsPassword Management

Management

ProjectsTasksTask Comments

Team & People

EmployeesCompany

Time & Attendance

HolidaysTask LogsTime Warnings

Communication

NotificationsProject Notes

Analytics & Reports

ReportsScreenshots

Advanced Features

Global SearchLive Activity

Employees

Complete Dyzo API Documentation - Project Management, Team Collaboration & Time Tracking Platform

API Overview

Capabilities and features

Manage employee records, profiles, permissions, and performance.

Key Features

Add and manage employee profiles
Update employee information and permissions
Track employee performance metrics
Search employees by various criteria
Manage profile pictures and documents
POST
/employee/add/
200 OK

Add New Employee

Create a new employee record.

JSONRequest Body
1{
2  "first_name": "Sarah",
3  "last_name": "Wilson",
4  "email": "[email protected]",
5  "phone": "+1-555-0123",
6  "designation": "Senior Developer",
7  "companyId": 1,
8  "salary": 85000
9}
GET
/employee/list/{company_id}/
200 OK

List All Employees

Get all employees in a company.

GET
/employee/list/activeUsers/{company_id}/
200 OK

List Active Employees

Get all active employees in a company. Returns employees where isActive=true and isDeleted=false, sorted alphabetically by name. Also includes a separate list of deleted employees with basic info (_id and name only).

GET
/employee/list/InactiveUsers/{company_id}/
200 OK

List Inactive Employees

Get all inactive employees in a company. Returns employees where isActive=false, regardless of deletion status. Useful for viewing deactivated or suspended employee accounts.

GET
/employee/me/{employee_id}/
200 OK

Get Employee Details

Get detailed employee information.

PATCH
/api/employees/{_id}/
200 OK

Update Employee (Full Fields)

Update any employee field. Supports partial updates via PATCH.

JSONRequest Body
1{
2  "first_name": "Sarah",
3  "last_name": "Johnson",
4  "name": "Sarah Johnson",
5  "email": "[email protected]",
6  "phone": "+1234567890",
7  "designation": "Lead Developer",
8  "salary": 95000,
9  "isAdmin": true,
10  "isTeamLeader": false,
11  "is_active": true,
12  "date_of_birth": "1990-05-15",
13  "date_of_joining": "2023-01-01",
14  "gender": "female",
15  "country_code": "US"
16}
PATCH
/employee/update-picture/{_id}/
200 OK

Update Profile Picture

Upload employee profile picture.

JSONRequest Body
1{
2  "profilePicture": "<base64_image>"
3}
GET
/api/performance/{company_id}/
200 OK

Get Employee Performance

Get performance metrics for employees.

GET
/employees/search/{company_id}/?q={query}
200 OK

Search Employees

Search employees by name, email, designation.