Not sure how to work with Emply's API to get a solution that fits your needs? This article will walk you through the options you have so you can choose the right approach.
(You can also start by reading Introduction to Emply's API).
Get data
Do you need data from Emply to other systems? Then you can retrieve data from a wide range of endpoints. If you want to retrieve data from Emply, you can take two different approaches with Emply's API. One approach is that you can retrieve the full data set of, among other things, employees, jobs and candidates created in the platform. The other option is to only retrieve data where a change has been made.
Full data set
If you need to retrieve all data on employees, candidates or anything else, it makes sense to retrieve the full data set.
This approach requires no additional setup in the system and data can be retrieved directly from all GET endpoints available in the API. However, this means that it is not possible to make special customizations, as the format of our API endpoints is fixed. It also means that is it necessary to compare data with precious datasets to find changes or use date filtering available on selected endpoints.
Use our API documentation.
Get inspiration for solutions:
Get documents from Onboarding Profile
This solution can also help if you need to
- Do user sync via API
- Create reporting
Updates
Depending on the integration or data flow you are building, it may make sense to download updates. For example, an update could be an employee's maste data that has changed or a candidate has just been hired. As soon as the change occurs, the system will generate a file that is ready to be retrieved in the API.
This approach offers the most customization options. You can choose which data to include in the solution and which changes will generate a data package.
This solution can also help if you need to
- Synchronize employee data
- Synchronize candidate documents
Add data
Want to create or update data in Emply from other systems? Emply's API has different endpoints to handle this. Among other things, it is possible to update data on employees or create users. You can take a closer look at our documentation to get an overview of the possibilities.
Patch workaround
Emply's API does not contain patch endpoint and therefore, when you want to update data, you must fill in all data in your request. If data it not filled in, the field will be overwritten with a blank and this can cause problems. API Patch work around