Sign in

v1

latestOpenAPI 3.0.12026-07-24192492466.5 KB
Employees

Get all Employees

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

get/hris/employees

Query parameters

employeeIdsstring

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

employeeNumbersstring

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

employmentStatusstring

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

inProbationboolean

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

inNoticePeriodboolean

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

lastModifiedstring date-time

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

searchKeystring

The search key allowed value must have atleast 3 characters.

pageNumberinteger
pageSizeinteger

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

Response

OK

succeededboolean

Gets or sets a value indicating whether this Keka.API.Web.Core.Response`1 is succeeded.

messagestring nullable

Gets or sets the message.

errorsstring[] nullable

Gets or sets the errors.

pageNumberinteger

Gets or sets the page number.

pageSizeinteger

Gets or sets the size of the page.

firstPagestring uri nullable

Gets or sets the first page.

lastPagestring uri nullable

Gets or sets the last page.

totalPagesinteger

Gets or sets the total pages.

totalRecordsinteger

Gets or sets the total records.

nextPagestring uri nullable

Gets or sets the next page.

previousPagestring uri nullable

Gets or sets the previous page.