Greythr API Directory

Greythr software is a comprehensive human resources management solution tailored to optimize and streamline HR processes for organizations of varying sizes. It offers a suite of functionalities that cover essential HR domains, including Employee Information Management, Payroll, Leave Management, and Attendance Management. By automating these processes, Greythr enables HR departments to enhance efficiency, reduce manual errors, and ensure compliance with payroll regulations, making it an indispensable tool for modern businesses.

One of the standout features of Greythr is its ability to facilitate seamless onboarding and offboarding workflows, alongside providing an HR Help Desk, Letters, Tasks & Checklists, and Payroll Compliance tools. These features collectively empower organizations to manage their workforce effectively, from hiring to retirement. Furthermore, the Greythr API integration process allows businesses to extend the software's capabilities, ensuring that it can be customized to meet specific organizational needs. This flexibility makes Greythr a versatile choice for companies looking to enhance their HR operations.

Key highlights of GreytHR APIs

‍

GreytHR API Endpoints

Attendance

• GET https://api.greythr.com/attendance/v2/employee/insights : Get Attendance Summary for All Employees
• GET https://api.greythr.com/attendance/v2/employee/muster : Get Attendance Muster Details for All Employees
• GET https://api.greythr.com/attendance/v2/employee/{employee-id}/insights : Get Employee Attendance Summary
• GET https://api.greythr.com/attendance/v2/employee/{employee-id}/muster : Get Employee Attendance Muster
• GET https://api.greythr.com/attendance/v2/employee/{employee-id}/swipes : Get Employee Attendance Muster Raw Swipes

Employee Documents

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

Employee Information

• GET https://api.greythr.com/employee/v2/employees : Get All Employees
• GET https://api.greythr.com/employee/v2/employees/addresses/{address-type} : Get All Employee Address Details
• GET https://api.greythr.com/employee/v2/employees/assets : Get All Employee Asset Details
• GET https://api.greythr.com/employee/v2/employees/bank : Get All Employee Bank Details
• GET https://api.greythr.com/employee/v2/employees/categories : Get All Employee Positions Details
• GET https://api.greythr.com/employee/v2/employees/families/{relationtype-id} : Get Employees Family Details
• GET https://api.greythr.com/employee/v2/employees/identities/{identity-code} : Get All Employee Identity Details
• GET https://api.greythr.com/employee/v2/employees/lookup?q={Employee+No.%2FEmail%2FGuid%2FAccess+card%2F+Personal+email} : Employee Lookup
• GET https://api.greythr.com/employee/v2/employees/org-tree : Get Orgtree Reporting Structure
• GET https://api.greythr.com/employee/v2/employees/personal : Get All Employee Personal Details
• GET https://api.greythr.com/employee/v2/employees/pf : Get All Employee PF & ESI Details
• GET https://api.greythr.com/employee/v2/employees/profile : Get All Employee Profile Details
• GET https://api.greythr.com/employee/v2/employees/qualifications : Get All Employee Qualifications Details
• GET https://api.greythr.com/employee/v2/employees/separation : Get All Employee Separation Details
• GET https://api.greythr.com/employee/v2/employees/statutory/india : Get All Employee Statutory Details
• GET https://api.greythr.com/employee/v2/employees/work : Get All Employee Work Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id} : Update Employee Information
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type} : Update Employee Address Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/assets : Get Employee Asset Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/assets/{asset-id} : Update Employee Assets
• POST https://api.greythr.com/employee/v2/employees/{employee-id}/bank : Add Employee Bank Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/categories : Get Employee Positions Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/families : Get Employee Family Details
• DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/families/{relation-id} : Delete Family Member Details
• POST https://api.greythr.com/employee/v2/employees/{employee-id}/family-benefit : Add Employee Family Benefits
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/identities : Get Employee's All Identity Details
• DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code} : Delete Employee Identity
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree : Get Employee Manager Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/personal : Get Employee Personal Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/pf : Get Employee PF & ESI Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/profile : Update Employee Profile Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications : Get Employee Qualifications Details
• DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications/{qualification-id} : Delete Employee Qualifications Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/separation : Update Employee Separation Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/statutory/india : Update Employee Statutory Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/work : Get Employee Work Details

HR

• POST https://api.greythr.com/hr/v2/lov : Post List of Values for Categories
• GET https://api.greythr.com/hr/v2/lov/banks/{bankId}/branches : Get Bank Branch Details
• POST https://api.greythr.com/hr/v2/lov/org/entities : Add greytHR Org Entities

Leave

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

Payroll

• GET https://api.greythr.com/payroll/v2/employees/handentry : Get All Employee Hand Entry Salary Items
• GET https://api.greythr.com/payroll/v2/employees/resettlement/{payrollMonth} : Get Employees Resettlement for a Month
• GET https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}} : Get Salary Statement for a Month
• GET https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}/{employee-id} : Get Salary Statement for an Employee for a Month
• GET https://api.greythr.com/payroll/v2/employees/{employee-id} : Get Employee Hand Entry Salary Items
• POST https://api.greythr.com/payroll/v2/form16/download : Form16 Download API
• GET https://api.greythr.com/payroll/v2/pay-period/list : Get Pay Period API For The Financial Year
• GET https://api.greythr.com/payroll/v2/pay-period?inputDate=2024-02-11 : Get Pay Period For Particular Date
• GET https://api.greythr.com/payroll/v2/payslip/download?encoded=true : Generate Payslip For Employee
• GET https://api.greythr.com/payroll/v2/salary/repository : Get Salary Repository Items
• GET https://api.greythr.com/payroll/v2/salary/revision/difference/employees/{employee-id} : Get Salary Revision Difference
• POST https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id} : Add Salary Revision
• GET https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}/{status} : Get Salary Revision History
• POST https://api.greytip.com/payroll/v2/loan : Create Loan for Employee
• DELETE https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id} : Delete Attendance Snapshot

User

• GET https://api.greythr.com/user/v2/users : Get Users List
• POST https://api.greythr.com/user/v2/users/{userid}/auth : User SSO Authentication

Miscellaneous

• POST https://api.greytip.com/pengo/v1/admin/payslip/download?encoded=false : Payslip Download
• GET https://apigee-test.greythr.com/employee/v2/employees/employeeId/card-details/cardId : Get Employee Card Details
• POST https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details : Add Employee Card Details
• DELETE https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details/{cardId} : Delete Employee Card Details

GreytHR API FAQ

1. How can I access the greytHR API?
   • Answer: To access the greytHR API, you need to create an API user within the greytHR Admin portal. Navigate to Settings > My Account > API Users, then click on Create API User. Fill in the required details and assign appropriate roles to define the API user's permissions. GreyHR Freshdesk
2. What authentication method does the greytHR API use?
   • Answer: The greytHR API utilizes OAuth 2.0 for authentication. After creating an API user, you can obtain an access token by sending a POST request to the /uas/v1/oauth2/client-token endpoint, using the client ID and client credentials obtained during the registration process. This access token must be included in the Authorization header of subsequent API requests. Postman
3. Are there rate limits for the greytHR API?
   • Answer: The official documentation does not specify explicit rate limits for the greytHR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
4. Can I retrieve employee data using the greytHR API?
   • Answer: Yes, the greytHR API provides endpoints to retrieve employee data. For example, you can use the GET /employee/v2/employees endpoint to fetch a list of all employees, with options to filter based on parameters like state, status, and categories. Postman
5. Does the greytHR API support webhooks for real-time data updates?
   • Answer: As of the latest available information, the greytHR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.

‍

Get Started with GreytHR API Integration

1. Create an API User: Administrators can create API users through the greytHR Admin portal by navigating to Settings > My Account > API Users and clicking "Create API User." GreyHR Freshdesk
2. Enable API Roles: After creating an API user, enable the necessary roles by selecting "API User Provisioning" and granting the required access permissions. GreyHR Freshdesk
3. Generate API Credentials: Once roles are assigned, generate API credentials (Client ID and Client Secret) for the API user to facilitate authentication. GreyHR Freshdesk
4. Authenticate Using OAuth 2.0: Utilize the Client ID and Client Secret to obtain an access token via the OAuth 2.0 protocol, which will be used to authenticate API requests. Postman
5. Explore API Endpoints: Familiarize yourself with various API endpoints to perform operations such as retrieving employee details, managing leave records, and processing attendance data. GreyHR API Documentation

Additional Resources:

• Postman Collection: greytHR offers a Postman collection to facilitate testing and understanding of API endpoints. Postman
• Developer Community: Engage with the greytHR developer community for support, insights, and updates related to the APIs.

‍

About Knit

Knit API offers a convenient solution for quick and seamless integration with GreytHR API. Our AI-powered integration platform allows you to build any GreytHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to GreytHR API.‍

To sign up for free, click here. To check the pricing, see our pricing page.