v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

HRIS Employee

List HRIS Employees

List call that returns all the employee profiles.

get/api/v2/core/hris-systems/{systemId}/hris-employees

Path parameters

systemIdstring required

HRIS system ID. Use default if you have only one system and dont want to use system-Id.

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

filterQuerystring

Filter query using predefined filter arguments documented here

querystring

Any wildcard text to search in position

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

locationCountrystring nullable

The location country of the employee

bonusAmountinteger nullable

The amount of the bonus of the employee

managerEmailstring nullable

The email of the manager

positionCriticalitystring[] nullable

The criticality of the position of the employee

bonusAmountCurrencystring nullable

The currency of the bonus given to the employee

locationstring nullable

The location of the employee

firstNamestring nullable

First Name of employee

bustring nullable

The Business unit of the employee

emailstring nullable

List of Emails of the employee comma seperated

bonusAmountFrequencystring nullable

The frequency of the bonus pay to the employee

basePayCurrencystring nullable

The currency of the base pay of the employee

levelstring nullable

The job level of the employee

userIdstring nullable

The userId of the employee

lastReviewRatingstring nullable

The last review rating of the employee

customInfoobject nullable

The custom info captured for the employee by custom fields

tenureYearsnumber float nullable

The total tenure years of the employee

systemIdstring nullable

The system id of the HRIS system in EF

companyNamestring nullable

The company name of the employee

phonestring nullable

The phone number of the employee

titlestring nullable

The title of the employee

idstring nullable

The unique id of the Employee in the HRIS system

terminationDatestring nullable

The termination date of the employee

hiringDatestring nullable

The hiring date of the employee

managerUserIdstring nullable

The user id of the manager in HRIS system

lastActivityTsinteger nullable

The last activity timestamp

managerFullnamestring nullable

The full name of the manager

jobCodestring nullable

The job code of the employee

tenureCurrentRoleYearsnumber float nullable

The no of years the employee is in current role

basePayFrequencystring nullable

The frequency of the base pay of the employee

lobstring nullable

The lob of the employee

roleChangeDatestring nullable

The last role change date of the employee

rolestring nullable

The role of the employee

eligibleForTransferboolean nullable

Is the employee eligible for transfer or not

lastNamestring nullable

Last Name of employee