v1
latestOpenAPI 3.1.02026-08-045901.5 MBView Employee
This API functionality is used to fetch employee information. It is used in view profile page and in employee onboarding page
get/employee/{gid}
Path parameters
gidinteger required
Reference code of the employee. This is generated when the employee is added to the system and is used to link salary details with that employee.
Headers
api-tokenstring
Generate token from authentication api
x-api-keystring
Response
200
Example response
{
"status": 1,
"message": "success",
"data": {
"employee_id": "20",
"name": "sample",
"designation": "Accountant-1",
"department": "Finance",
"supervisor": "Test Supervisor",
"reporting_to": "Test Data",
"branchid": "1717154477",
"branch": "Small Finance Bank Limited",
"doj": "2024-07-12",
"office_email": "sample@indiafilings.com",
"personalnumber": "9345773617",
"officemobile": "8925817448",
"gid": "2097790726",
"employee_status": "Active",
"status": "Not in Office",
"dob": "1996-05-03",
"blood_group": "O+",
"marital_status": "Unmarried",
"gender": "Female",
"shift": "12:00 AM - 11:59 PM",
"stime": "1741781734",
"bank": {
"bankname": "ABC Bank",
"ifsccode": "ABC0001234",
"update_on": "2025-04-21 14:30:03",
"bankbranch": "Chennai Main",
"updated_by": "2051784300",
"accountname": "Sample",
"account_type": "Savings",
"accountnumber": "123456789012"
},
"presentaddress": [
{
"city": "Chennai",
"state": "TAMIL NADU",
"country": "INDIA",
"pincode": "600001",
"address_line1": "123, MG Road",
"address_line2": "Near Metro Station"
}
],
"permanentaddress": [
{
"city": "Madurai",
"state": "TAMIL NADU",
"country": "INDIA",
"pincode": "625001",
"address_line1": "456, Anna Nagar",
"address_line2": "Opp. Bus Stand"
}
],
"uan_number": "123456789012",
"esi_number": "1234567890",
"aadhar": "123456789012",
"pan": "ABCDE1234F",
"personal_email": "sample123@gmail.com",
"fathers_name": "Test",
"emergency_contact": "9952750732",
"religion": "Islam",
"employment_type": "Full Time",
"created_on": "2024-07-12 15:41:12",
"created_by": "2051784300",
"updated_on": "2025-04-21 14:30:03",
"updated_by": "2051784300",
"created_by_name": "HR Admin",
"role": "Employee",
"peopleid": "1720692398059",
"regime": {
"FY 2025-2026": {
"regime": "Old",
"added_by": "2051784300",
"added_on": "2025-04-07 16:34:00"
}
},
"leave_policy": "Standard Policy",
"image": "https://dhr.ledgers.cloud/images/female.jpeg",
"Salary": {
"basic": 25000,
"CTC_per_month": 50000,
"CTC_per_year": 600000,
"Gross": 50000,
"Netpay": 50000,
"startdate": "2024-10-01",
"enddate": "-",
"TaxableBenefits": {
"FP_Hra": "10000",
"FP_SpecialAllowance": "15000"
},
"history": [
{
"basic": 49270,
"CTC_per_month": 70900,
"CTC_per_year": 850800,
"Gross": 69100,
"Netpay": 67300,
"startdate": "2023-06-01",
"enddate": "-",
"TaxableBenefits": {
"FS_Hra": "8854",
"FS_MedicalAllowance": "5264",
"FS_ConveyanceAllowance": "5712"
},
"RetirementBenefits": {
"EmployerPF": 1800,
"EmployeePF": 1800
},
"Settings": {
"Wages": [
{
"Hra": "Yes",
"W_Basic": "Yes",
"MedicalAllowance": "Yes",
"ConveyanceAllowance": "Yes"
}
],
"PF_Rate": "percentage",
"PF_Type": "Limited",
"ProvidentFundValue": 12
}
}
]
}
},
"statusCode": "200"
}