Simployer HR Connect API - now available!

8/12/2024 Compensation, Employment Contracts, People Admin Administrators

With the new HR Connect API we provide even more efficient management of HR-related data making it easier for you to read and analyze what's going on in Simployer HRM. And in the extension providing you with a better overview of important metrics and understanding of your business and organization. How about that!? 

About the API

The HR Connect API provides endpoints to retrieve information about employees, organizational units, contact data, employment contracts, and more within your organization. The API is secured by bearer token(s) generated in SimplAuth.It can be accessed using various third party tools such as Excel and Power BI - in addition to being consumed directly via your internal systems. 

How to start using HR Connect API

In order to get going with HR Connect API you need to get authorized by SimpleAuth token. This is done by creating your own client in the Simployer Admin Center.

See this link for instructions https://developer.simployer.com/our-apis/simplauth/. 

Want to link the HR Connect API to aforementioned third party tools such as Excel and Power BI?

Here's another guide for you: https://developer.simployer.com/our-apis/connect-api-through-power-query/

The actual API can be found here: https://hrconnect.simployer.com/index.html    

A few examples and details

In the current version HR Connect API supports export functionality through GET operations. Most entities expose following structure of endpoints:
  • Retrieve all entities (ex – Get all email addresses)
  • Retrieve entities related to given unit (ex – Get all email addresses related to person B)
  • Retrieve single entity based on given identifier
  • Retrieve all entities of given type (ex – Get all primary email addresses)
For endpoints ‘Retrieve all’ there is a pagination mechanism that allows to get data in chunks. Pagination parameter are passed as query parameters.
Default value for pagination is page 1 and 100 records. Endpoints with pagination support will return response decorated with headers that inform what is total count of records, whether there is a next page, and so on. For example pagination headers response:
x-has-next-page: True
x-page: 1
x-page-size: 100
x-total-count: 1034
x-total-pages: 11