# Overview The ELMO API is a RESTful based API that facilitates user information management within the ELMO ecosystem. Our API is designed to empower businesses, including our valued customers and partners, in creating scalable integration solutions aligned with their evolving business needs. By using this API, you gain access to invaluable HR data, enabling you to supercharge your applications and integrations, driving efficient workflows and enhancing core business processes. The below section provides an overview of the current capabilities of the API: * Get users list * Get an individual user's details * Get a user template to create a new user * Create new user * Get positions list * Get locations list * Get department list * Get metadata of configurable fields * Get all users employment details * Get an individual user's employment details * Get legal entity details * Get payroll calendar details * Get leave request details * Get leave type details Note that this is the latest version of the API Documentation that utilises OAuth2 authentication. The previous version of the documentation can be found at [API Documentation version 1](/v1/index.html) Please be advised that endpoints labelled as beta are intended for customer testing and feedback and may change based on feedback, potentially impacting backward compatibility. Consider this before integrating it with production systems to avoid disruptions to your integrations. --- # Authentication ELMO API utlises OAuth2.0 authentication. Company Admins are able to create and manage API Credentials. --- # API Rate Limits There are limits applied to the number of API requests your application can make. This limit is lower in sandbox and higher in production environments. The ELMO User API also supports custom usage plans to scale with your organisation's needs. Sandbox Environment * **Rate limit**: 1 request per second * **Burst limit**: 10 * **Quota**: 500 requests in 1 day Production Environment * **Rate limit**: 1 requests per second * **Burst limit**: 10 * **Quota**: 5000 requests in 1 day --- # Generating Client SDKs You can use the OpenAPI Specification file to generate a client SDK. You can download the file from [here](index.yaml). Then use the tool of your choice to generate a client SDK. You can get started [here](https://swagger.io/tools/swagger-codegen/).

Go to Download