Learn how to access, authenticate with, and retrieve data from the Simployer Classic HRConnect API.

The HRConnect API is a REST API that lets you retrieve core data from Simployer HRM. You can use the API with third-party tools such as Excel and Power BI or consume it directly from your own systems.

For authentication instructions, see the article about SimplAuth.

Get started with the Simployer Classic HRConnect API

1. Get authorized with a SimplAuth token. To do this, create your own client in Simployer Admin Center. See the article about SimplAuth for instructions.
2. To connect the HRConnect API to a third-party tool such as Excel or Power BI, see the article "How to connect to HRConnect API through Power Query."
3. Access the HRConnect API at https://hrconnect.simployer.com/index.html.

Authenticate with the Simployer Classic HRConnect API in Swagger

In Swagger, click Authorize, and then paste your JWT token.

Use the Simployer Classic HRConnect API endpoints

The current version of the HRConnect API supports data export through GET operations. Most entities provide the following endpoint structure:

• Retrieve all entities, for example, all email addresses
• Retrieve entities linked to a specified entity, for example, all email addresses linked to person B
• Retrieve one entity using a specified identifier
• Retrieve all entities of a specified type, for example, all primary email addresses

Use pagination in the Simployer Classic HRConnect API

The HRConnect API provides pagination for endpoints that retrieve all entities. Pagination lets you retrieve data in separate pages. Send the pagination parameters as query parameters.

The default values are page 1 and a page size of 100 records. Endpoints that support pagination return response headers with information such as the total number of records and whether another page is available.

Example pagination headers in the response:

x-has-next-page: True x-page: 1 x-page-size: 100 x-total-count: 1034 x-total-pages: 11