greytHR API Guide

greytHR API Directory

‍

greytHR is a leading HR and Payroll software provider for small and medium sized companies. It enables HR teams and professionals to automate all people operations including employee information management, leave and attendance management, training, appraisals, compensation, etc. greytHR API enables developers to access HR related information like Employee/Leave/Attendance/Salary for seamless exchange between different applications. 

greytHR API Authentication

greytHR is based on oAuth2 based authentication for access to APIs, which is an industry-standard protocol for authorization. Since the greytHR API captures a lot of sensitive and confidential information, only authorized entities get access to it. Each API request is authenticated with an auth-token using the client id and client credentials obtained during the registration process. A verified username and password is used for basic authentication. 

greytHR API API Objects, Data Models & Endpoints

If you are working with greytHR API for integration with other applications, it is important to understand the data models, objects and endpoints to facilitate data normalization and accurate API requests. Some of these are captured below to help you get started. 

Employee

• GET Get all Employees: https://api.greythr.com/employee/v2/employees?page=1&size=35 
• GET Get Employee: https://api.greythr.com/employee/v2/employees/{employee-id}
• GET Employee Lookup: https://api.greythr.com/employee/v2/employees/lookup?q={EmployeeNo./Email/Guid/Access card/ Personal email}
• POST Add Employee: https://api.greythr.com/employee/v2/employees
• PUT Update Employee: https://api.greythr.com/employee/v2/employees/{employee-id}
• GET Get All Employee Profile Details: https://api.greythr.com/employee/v2/employees/profile
• GET GET All employees Photo: https://api.greythr.com/hr/v2/employees/photo?photoSize=large&page=1&size=0
• GET Get Employee Photo: https://api.greythr.com/hr/v2/employee/{employeeId}/photo
• GET Get Employee Profile Details: https://api.greythr.com/employee/v2/employees/{employee-id}/profile
• PUT Update Employee Profile Details: https://api.greythr.com/employee/v2/employees/{employee-id}/profile
• GET Get All Employee Personal Details: https://api.greythr.com/employee/v2/employees/personal
• GET Get Employee Personal Details: https://api.greythr.com/employee/v2/employees/{employee-id}/personal
• PUT Update Employee Personal Details: https://api.greythr.com/employee/v2/employees/{employee-id}/personal
• GET Get All Employee Work Details: https://api.greythr.com/employee/v2/employees/work
• GET Get Employee Work Details Copy: https://api.greythr.com/employee/v2/employees/{employee-id}/work
• PUT Update Employee Work Details: https://api.greythr.com/employee/v2/employees/{employee-id}/work
• GET Get All Employee Separation Details: https://api.greythr.com/employee/v2/employees/separation
• GET Get Employee Separation Details Copy: https://api.greythr.com/employee/v2/employees/{employee-id}/separation
• PUT Update Employee Separation Details: https://api.greythr.com/employee/v2/employees/{employee-id}/separation
• GET Get All Employee Address Details: https://api.greythr.com/employee/v2/employees/addresses/{address-type}
• GET Get Employee Address Details: https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type}
• PUT Update Employee Address Details: https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type}
• DELETE Delete Employee Address Details: https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type}
• GET Get All Employee Statutory Details: https://api.greythr.com/employee/v2/employees/statutory/india
• GET Get Employee Statutory Details: https://api.greythr.com/employee/v2/employees/{employee-id}/statutory/india
• PUT Update Employee Statutory Details: https://api.greythr.com/employee/v2/employees/{employee-id}/statutory/india
• GET Get Orgtree - Reporting Structure: https://api.greythr.com/employee/v2/employees/org-tree
• GET Get Employee Manager details: https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree
• POST Add Employee Manager: https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree
• PUT Update Employee Manager: https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree
• GET Get All Employee Positions details: https://api.greythr.com/employee/v2/employees/categories
• GET Get Employee Positions Details: https://api.greythr.com/employee/v2/employees/{employee-id}/categories
• POST Add Employee Positions: https://api.greythr.com/employee/v2/employees/{employee-id}/categories
• GET Get All Employee Bank Details: https://api.greythr.com/employee/v2/employees/bank
• GET Get Employee Bank Details: https://api.greythr.com/employee/v2/employees/{employee-id}/bank
• POST Add Employee Bank Details: https://api.greythr.com/employee/v2/employees/{employee-id}/bank
• PUT Update Employee Bank Details: https://api.greythr.com/employee/v2/employees/{employee-id}/bank
• GET Get All Employee PF & ESI details: https://api.greythr.com/employee/v2/employees/pf
• GET Get Employee PF & ESI details: https://api.greythr.com/employee/v2/employees/{employee-id}/pf
• POST Add Employee PF & ESI details: https://api.greythr.com/employee/v2/employees/{employee-id}/pf
• PUT Update Employee PF & ESI details: https://api.greythr.com/employee/v2/employees/{employee-id}/pf
• GET Get Employee's All Identity Details: https://api.greythr.com/employee/v2/employees/{employee-id}/identities
• GET Get Employee Identity Details: https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code}
• POST Add Employee Identity: https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code}
• PUT Update Employee Identity: https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code}
• DELETE Delete Employee Identity: https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code}
• GET Get Employees Family Details: https://api.greythr.com/employee/v2/employees/families/{relationtype-id}
• GET Get Employee Family Details: https://api.greythr.com/employee/v2/employees/{employee-id}/families
• POST Add family member to Employee: https://api.greythr.com/employee/v2/employees/{employee-id}/families
• PUT Update Family member details: https://api.greythr.com/employee/v2/employees/{employee-id}/families/{relation-id}
• DELETE Delete Family member details: https://api.greythr.com/employee/v2/employees/{employee-id}/families/{relation-id}
• GET Get All Employee Asset details: https://api.greythr.com/employee/v2/employees/assets
• GET Get Employee Asset details: https://api.greythr.com/employee/v2/employees/{employee-id}/assets
• POST Add Asset to Employee: https://api.greythr.com/employee/v2/employees/{employee-id}/assets
• POST Add Asset to Employee: https://api.greythr.com/employee/v2/employees/{employee-id}/assets
• DELETE Delete Update Family member details: https://api.greythr.com/employee/v2/employees/{employee-id}/assets/{asset-id}
• GET Get All Employee Qualifications details: https://api.greythr.com/employee/v2/employees/qualifications
• GET Get Employee Qualifications details: https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications
• POST Add Employee Qualifications: https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications
• PUT Update Employee Qualifications details: https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications/{qualification-id}
• DELETE Delete Employee Qualifications details: https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications/{qualification-id}
• GET Get Employee All Card Details: https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details
• GET Get Employee Card Details: https://apigee-test.greythr.com/employee/v2/employees/employeeId/card-details/cardId
• POST Add Employee Card Details: https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details
• DELETE Delete Employee Card Details: https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details/{cardId}

Leave

• GET Get Leave Balance details for All Employees: https://api.greythr.com/leave/v2/employee/years/{{Year}}/balance
• GET Get Employee Leave Balance for a year: https://api.greythr.com/leave/v2/employee/{employee-id}/years/{{Year}}/balance
• GET Get Leave Transactions details for All Employees: https://api.greythr.com/leave/v2/employee/transactions?start={{StartDate}}&end={{EndDate}}
• GET Get Employee Leave Transactions: https://api.greythr.com/leave/v2/employee/{employee-id}/transactions?start={{StartDate}}&end={{EndDate}}
• POST Leave Transaction: https://api.greythr.com/leave/v2/employee/transactions

Attendance

• GET Get Attendance Summary for All Employees: https://api.greythr.com/attendance/v2/employee/insights?end={{EndDate}}&start={{StartDate}}
• GET Get Employee Attendance Summary: https://api.greythr.com/attendance/v2/employee/{employee-id}/insights?end={{EndDate}}&start={{StartDate}}
• GET Get Employee Attendance Summary: https://api.greythr.com/attendance/v2/employee/{employee-id}/insights?end={{EndDate}}&start={{StartDate}}
• GET Get Employee Attendance Muster: https://api.greythr.com/attendance/v2/employee/{employee-id}/muster?end={{EndDate}}&start={{StartDate}}

Payroll

• GET Get All Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/handentry
• GET Get Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
• GET Get Salary Repository Items: https://api.greythr.com/payroll/v2/salary/repository
• POST Add Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
• PUT Update Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
• DELETE Delete Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
• GET Get Salary Statement for a Month: https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}
• GET Get Salary Statement for an Employee for a Month: https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}/{employee-id}
• GET Get Employees Resettlement for a Month: https://api.greythr.com/payroll/v2/employees/resettlement/{payrollMonth}
• POST Add Salary Revision: https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}
• GET Get Salary Revision History: https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}/{status}
• GET Get Salary Revision Difference: https://api.greythr.com/payroll/v2/salary/revision/difference/employees/{employee-id}
• GET Get Attendance Snapshot details: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}
• POST Save Attendance Snapshot: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}
• DELETE Delete Attendance Snapshot: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}

List of Values

• POST Get greytHR LOV: https://api.greythr.com/hr/v2/lov
• POST Get greytHR Position/Category: https://api.greythr.com/hr/v2/lov
• GET Get Bank Branch Details: https://api.greythr.com/hr/v2/lov/banks/{bankId}/branches
• POST Add greytHR Org Entities: https://api.greythr.com/hr/v2/lov/org/entities

Documents

• GET Get Employee Documents: https://api.greythr.com/employee/v2/emp-docs/{employeeId}/{categoryId}
• GET Download Employee Documents: https://api.greythr.com/employee/v2/emp-docs/{employeeId}/{documentId}/{fieId}
• POST Add Employee Document Category: https://api.greythr.com/employee/v2/emp-docs/category
• POST Add Employee Document: https://api.greythr.com/employee/v2/employee-docs/{employeeId}/{category}

Users

• POST Add New Users: https://api.greythr.com/user/v2/users
• GET Get Users List: https://api.greythr.com/user/v2/users
• GET Get Employee User ID: https://api.greythr.com/user/v2/users?userType=employee&userName=Employee Number
• POST User SSO: https://api.greythr.com/user/v2/users/{userid}/auth

greytHR API Use Cases 

• Centralized employee information management and simplification of HR processes by eliminating inconsistencies, duplication and clutter in employee information
• Easy payroll management with accurate and timely payouts
• Seamless leave management with accurate leave accounting and integration with payroll
• Real time attendance management, easy shift and overtime management
• Goal alignment and performance management, progress tracking, rewards achievements

Top customers

greytHR provides HRMS services to 20,000+ companies across 250+ cities, including:

‍

• Dunzo, a 24x7 delivery app
• HealthifyMe, an Indian digital health and wellness company
• Rapido, an Indian ride-hailing service
• Hutchinson, a French manufacturer of non-tire rubber
• Lentra, a new-age domain-native platform 
• ClickDesk, a live support chat software 
• CORE Energy Systems, an emerging engineering services and project management company

greytHR API FAQs

• How can admin enable the role for API users? Answer
• How to generate API credentials for the greytHR admins? Answer
• Is it possible to configure API credentials in Tally without enabling the integration of greytHR? Answer

How to integrate with greytHR API 

To integrate with the greytHR API, you need to create an account. You can create an account here. You can then go through this documentation to understand the REST API for external applications to integrate and interoperate with greytHR. 

Get started with greytHR API 

greytHR offers a freemium model for its users. While some features for a certain number of employees can be availed free of cost, the paid version starts at ₹3495/month adding more features which users can leverage. There are more premium tiers to choose from. Each pricing plan comes with a free trial. 

‍

However, integrating with greytHR API with in-house resources can be quite expensive and time consuming, for both building and managing the integration. You can significantly bring this cost down by partnering with a platform like Knit. With a nominal integration cost, Knit helps you integrate with a unified HRIS API, with which you can connect with its bouquet of HRIS applications, including greytHR, at no additional cost. As a unified API, Knit helps you connect with your preferred HRIS applications in a fraction of the cost and time. Book a demo today to learn more!