Employee

Represents an employee within a company or organization. This object is available in API version 48.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

Field	Details
AlternateEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s alternate email address.
CurrentWellnessStatus	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s current wellness status. Possible values are: `Available To Work` `Remote Work Only` `Unavailable` `Unknown`
DateOfBirth	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s date of birth.
Email	Type email Properties Create, Filter, Group, idLookup, Sort, Update Description The employee’s email address. This field is unique within your organization.
EmployeeNumber	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The employee's employment ID for the organization they were hired into. This field is unique within your organization.
EmployeeStatus	Type picklist Properties Create, Filter, Group, Sort, Update Description Required. The employee's current work status. Possible values are: `Active` `Inactive` `Leave` `Terminated`
EmploymentType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee's full-time or part-time status. Possible values are: `Full-Time` `Part-Time`
FirstName	Type string Properties Create, Filter, Group, Sort, Update Description Required. The employee’s first name.
Gender	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s gender. Possible values are: `Female` `Male` `Non-Binary / Non-Conforming` `Other` `Prefer Not to State` `Transgender Female` `Transgender Male`
HomeAddress	Type address Properties Filter, Nillable Description The employee’s home address.
HomeCity	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city for the employee’s home address.
HomeCountry	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The county for the employee’s home address.
HomeGeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of accuracy of an employee’s home address geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates. Possible values are: `Address` `Block` `City` `County` `ExtendedZip` `NearAddress` `Neighborhood` `State` `Street` `Unknown` `Zip`
HomeLatitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with HomeLongitude to specify the precise geolocation of the employee’s home address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
HomeLongitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with HomeLatitude to specify the precise geolocation of the employee’s home address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
HomePhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s home phone number.
HomePostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code for the employee’s home address.
HomeState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state for the employee’s home address.
HomeStreet	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street for the employee’s home address.
IndividualId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the Individual record that this employee is assigned to.
InternalOrganizationUnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the InternalOrganizationUnit this employee is assigned to.
JobProfile	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s job profile at the company.
LastName	Type string Properties Create, Filter, Group, Sort, Update Description Required. The employee’s last name.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
LocationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the Location that this employee is assigned to.
ManagerId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the Employee record of the employee's manager.
MiddleName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s middle name.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The Employee record name.
NameSuffix	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The employee’s suffix.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this record. Default value is the user logged in to the API to perform the create.
PreferredFirstName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name the employee prefers to be called.
PreferredPronoun	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The employee's preferred pronoun. Possible values are: `He/Him/His` `Other/Ask Me` `She/Her/Hers` `They/Them/Theirs`
StatusAsOf	Type dateTime Properties Create, Filter, Sort, Update Description Required. Start date of the employee’s current status.
StatusEndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Planned end date for the employee’s status.
WorkPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The employee's formatted work phone number including country code and extension.
WorkerType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The type of worker for the employee. Possible values are: `Alumnus` `Contractor` `Employee` `Intern`

SOAP API Developer Guide

Employee

Supported Calls

Fields

See Also