Get started with HRConnect API

• In order to get going with HR Connect API you need to get authorized by a SimpleAuth token. This is done by creating your own client in the Simployer Admin Center.
  • See this link for instructions 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: How to connect to HRConnect API through Power Query
• The actual API can be found here: 
  • Simployer Classic HRConnect API

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