EIeightfold
Employee

Get Employee

Changed on

Given a profile id of a employee, it returns all attributes of the employee

get/api/v2/core/employees/{profileId}

Request

Path parameters

profileIdstring required

Eightfold employee profile ID (supports both encoded and decoded ID)

Query parameters

includestring

Include additional fields in the response. Possible values are demandExperiences, temporalFields, managerProfileId

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

OK

managerEmailstring nullable

The email of the manager

locationstring nullable

The location of the employee

customInfoobject nullable

The custom info captured for the employee by custom fields

systemIdstring nullable

Integration system id for the employee

pronounsstring nullable

Preferred pronouns of the employee

terminationRegrettablestring nullable

Is the exit regrettable?

lastActivityTsinteger nullable

The last activity timestamp in seconds

terminationTsinteger nullable

The termination timestamp of the employee in seconds

jobCodestring nullable

The job code of the employee

timezonestring nullable

Working time zone

preferredFirstNamestring nullable

First name the employee goes by

rolestring nullable

The role of the employee

workplaceModelstring nullable

Workplace model (office / hybrid / remote)

personalEmailstring nullable

The personal email of the employee

isContingentboolean nullable

Is contingent

bustring nullable

The Business unit of the employee

maritalStatusstring nullable

Marital status of the employee

externalJobIdstring nullable

External job id of the employee

companyNamestring nullable

The company name of the employee

phonestring nullable

The phone number of the employee

managerUserIdstring nullable

The user id of the manager in HRIS system

eligibleForTransferboolean nullable

Is the employee eligible for transfer or not

lastNamestring nullable

Last Name of the employee

employeeTypestring nullable

Type of the employee

middleNamestring nullable

Middle name of the employee

employmentStatusstring nullable

Current employment status

firstNamestring nullable

First Name of the employee

userIdstring nullable

The userId of the employee

businessEmailstring nullable

The business email of the employee

lastReviewRatingstring nullable

The last review rating of the employee

employmentBasisstring nullable

Employment basis (full-time / part-time)

lastUpdatedTsinteger nullable

The last updated timestamp of the employee profile

managerFullnamestring nullable

The full name of the manager

rehireEligibilitystring nullable

Eligible for rehire?

userHighlightedSkillsstring[] nullable

Skills the employee has highlighted on their Career Hub profile. A write replaces the whole list; an empty list clears it. Only skills already on the profile are returned, in the profile's own spelling.

locationCountrystring nullable

The location country of the employee

positionCriticalitystring[] nullable

The criticality of the position of the employee

emailstring required

List of Emails of the employee comma seperated

levelstring nullable

The job level of the employee

terminationTypestring nullable

Termination type (voluntary / involuntary)

employeeIdstring required

The unique id of the Employee in the HRIS system

titlestring nullable

The title of the employee

idstring nullable

Profile id of the Employee in Eightfold

citizenshipstring[] nullable

Citizenships of the employee, more than one when dual. A write replaces the whole list: send every citizenship that should survive it. Send [] or null to clear all. Omit the field to leave the stored citizenships untouched.

preferredLastNamestring nullable

Last name the employee goes by

managerContactEmailstring nullable

The contact email of the manager

hiringTsinteger nullable

The hiring timestamp of the employee in seconds

roleChangeTsinteger nullable

The last role timestamp of the employee in seconds

shiftstring nullable

Shift label (morning / evening / night / general)

lobstring nullable

The lob of the employee

salutationstring nullable

Salutation / title of address

Changes

  • 9a8b3a927e93Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status