Get all Employees

get

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

Gets all employees / the specified employees based on employee search parameters.

Query Params

employeeIds

string

Comma separated list of one or more Employee ids you'd like to filter on.

employeeNumbers

string

Comma separated list of one or more Employee numbers you'd like to filter on.

employmentStatus

string

Comma separated list of one or more Employment Status you'd like to filter on, allowed values are Working, Relieved.

inProbation

boolean

Defaults to false

Fetches employees who are in probation. The allowed value is true or false.

inNoticePeriod

boolean

Defaults to false

Fetches employees who are in notice period. The allowed value is true or false.

lastModified

date-time

Date/time when this time off request was last modified, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm).

searchKey

string

The search key allowed value must have atleast 3 characters.

pageNumber

int32

pageSize

int32

Represents how many results you'd like to retrieve per request (page). Default is 100. Max is 200

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

OAuth2

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200OK