Employee Search API

Introduction

The Employee API lets you securely access comprehensive employee data from your HRIS without exposing any salary or compensation information. You can retrieve personal details, job data, group affiliations, custom fields, education, relationships, and exit records—all through a unified endpoint.

This guide is for account administrators, developers, and integration users who need to fetch employee data for reporting, syncs, or third-party integrations.

What you’ll need before you start:

API access enabled for your account
OAuth 2.0 credentials or an API token
HRIS module and any required add-ons

1. Obtain an access token

Use the Client Credentials flow for machine-to-machine calls
Capture the access_token and expires_in values

2. Set up your request

Include the token in the header:
Authorization: Bearer {access_token}
Set headers:
Accept: application/json
Content-Type: application/json (if needed)

3. Make your API calls

For multiple records:
GET /hris/employees
For a single employee:
GET /hris/employees/{id}

Filters & Query Parameters:

Parameter	Description
status	Filter by active, inactive, or terminated
lastModified	Please follow the format YYYY-MM-DDThh:mm:ss
department_id, location_id, manager_id	Filter by department, location, or manager
page[size], page[number]	Pagination controls (default: 50 per page)
sort	Sort by name, hire_date, updated_at (ascending or descending with -)
fields[employees]	Request only specific fields
include	Expand references like manager, department, location

Note: Use lastModified in UTC format to sync changes efficiently.

Base URL:

https://{company}.{environment}.com/api/v1/hris/employees

Field Reference / Parameters

Field	Description
id	Unique system ID
employee_number	Organization-wide employee code
external_id	Optional reference to external systems
personal	Includes name, contact, and demographic info
job	Job title, location, manager, employment status, dates
group_details	Business unit, cost center, legal entity
custom_fields	Tenant-specific key-value pairs
relation_details	Dependents and emergency contacts
education_details	Degrees, institutions, year of completion
exit_details	Last working day, exit reason, rehire status
updated_at	Last modified
links	Pagination controls (self, next, prev)
meta	Page info (page, page_size, total_pages, total_records)

Notes, Tips, Important, Warnings

Note: No salary or financial data is returned by this API.
Tip: Use sparse fieldsets (fields[employees]) to reduce payload size.
Important: API calls must follow your organization’s privacy and data use policies.

Sample Response payload (JSON)

We trust this article provides the guidance you need.