Get All Employees

This endpoint is suitable for getting the basic information of all employees within your organization. Also, you can filter the results returned by this endpoint by passing date, status, and limit as part of the request parameters.

Query Params
string

This field is optional. If not passed, the records returned will be for the holding company.

date

filter by date employee was created

int32
Defaults to 10

limit records

string

filter by status of employees active or inactive

boolean

filter by employees that can login to the system.

string

filter by employment date of employees e.g ['2025-02-01', '2025-03-31']

boolean

filter employees record by exit status

string

filter the employees record by exit date e.g e.g ['2025-02-01', '2025-03-31']

integer
Defaults to 1

filter records based on page number

string

This can be used to search for employees where the character matches. It searches the following fields: firstname, lastname, employee_code, and email.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json