Represents an employee within a company or organization. This object is available in API version 48.0 and later. In API version 49.0 and later, this object supports reports, criteria-based sharing rules, and history tracking, plus you can exclude individual fields from custom page layouts.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() undelete(), update(), upsert()
Special Access Rules
To access this object, you must have a Workplace Command Center permission set license and the Provides access to Workplace Command Center features system permission or have the Employee Management and Employee User add-on licenses.
Fields
| Field | Type | Properties | Description |
|---|---|---|---|
| AboutMe | textarea | Create, Filter, Group, Nillable, Sort, Update | Information about the employee, such as areas of interest or skills. Values can be provided on Employee’s profile page. This field is available even if Chatter is disabled. |
| AlternateEmail | Create, Filter, Group, Nillable, Sort, Update | The employee’s alternate email address. | |
| Availability | picklist | Create, Filter, Group, Nillable, Sort, Update | The employee’s availability status.Possible values are: <ul><li>In The Office</li><li>Out Of Office</li><li>Out Sick</li><li>PTO</li><li>Volunteering Time Off</li><li>Working Remotely</li></ul> |
| AvailabilityEndDate | dateTime | Create, Filter, Nillable, Sort, Update | The end date of the Employee’s availability, inclusive of the date. |
| AvailabilityStartDate | dateTime | Create, Filter, Nillable, Sort, Update | The start date of the Employee’s availability, inclusive of the date. |
| BannerPhotoUrl | url | Filter, Nillable, Sort | Read only. The URL for the employee's banner photo. Available in API v51.0 and later. |
| CurrentWellnessStatus | picklist | Create, Filter, Group, Nillable, Sort, Update | The employee’s current wellness status.Possible values are: <ul><li>Available To Work</li><li>Remote Work Only</li><li>Unavailable</li><li>Unknown</li></ul> |
| DateOfBirth | date | Create, Filter, Group, Nillable, Sort, Update | The employee’s date of birth. |
| Create, Filter, Group, idLookup, Nillable, Sort, Update | The employee’s email address. This field is unique within your organization. | ||
| EmployeeNumber | string | Create, Filter, Group, idLookup, Sort, Update | Required. The employee's employment ID for the organization they were hired into. This field is unique within your organization. |
| EmployeeStatus | picklist | Create, Filter, Group, Sort, Update | Required. The employee's current work status.Possible values are: <ul><li>Active</li><li>Inactive</li><li>Leave</li><li>Terminated</li></ul> |
| EmploymentType | picklist | Create, Filter, Group, Nillable, Sort, Update | The employee's full-time or part-time status.Possible values are: <ul><li>Full-Time</li><li>Part-Time</li></ul> |
| FirstName | string | Create, Filter, Group, Sort, Update | Required. The employee’s first name. |
| FullPhotoUrl | url | Filter, Nillable, Sort | Read only. The URL for the employee's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. Available in API v51.0 and later. |
| Gender | picklist | Create, Filter, Group, Nillable, Sort, Update | The employee’s gender.Possible values are: <ul><li>Female</li><li>Male</li><li>Non-Binary / Non-Conforming</li><li>Other</li><li>Prefer Not to State</li><li>Transgender Female</li><li>Transgender Male</li></ul> |
| HomeAddress | address | Filter, Nillable | The employee’s home address. |
| HomeCity | string | Create, Filter, Group, Nillable, Sort, Update | The city for the employee’s home address. |
| HomeCountry | string | Create, Filter, Group, Nillable, Sort, Update | The county for the employee’s home address. |
| HomeGeocodeAccuracy | picklist | Create, Filter, Group, Nillable, Restricted picklist, Sort, Update | 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: <ul><li>Address</li><li>Block</li><li>City</li><li>County</li><li>ExtendedZip</li><li>NearAddress</li><li>Neighborhood</li><li>State</li><li>Street</li><li>Unknown</li><li>Zip</li></ul> |
| HomeLatitude | double | Create, Filter, Nillable, Sort, Update | 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 | double | Create, Filter, Nillable, Sort, Update | 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 | phone | Create, Filter, Group, Nillable, Sort, Update | The employee’s home phone number. |
| HomePostalCode | string | Create, Filter, Group, Nillable, Sort, Update | The postal code for the employee’s home address. |
| HomeState | string | Create, Filter, Group, Nillable, Sort, Update | The state for the employee’s home address. |
| HomeStreet | textarea | Create, Filter, Group, Nillable, Sort, Update | The street for the employee’s home address. |
| IndividualId | reference | Create, Filter, Group, Nillable, Sort, Update | A reference to the Individual record that this employee is assigned to. |
| InternalOrganizationUnitId | reference | Create, Filter, Group, Nillable, Sort, Update | A reference to the InternalOrganizationUnit this employee is assigned to. |
| JobProfile | picklist | Create, Filter, Group, Nillable, Sort, Update | The employee’s job profile at the company. |
| LastName | string | Create, Filter, Group, Sort, Update | Required. The employee’s last name. |
| LastReferencedDate | dateTime | Filter, Nillable, Sort | The timestamp for when the current user last viewed a record related to this record. |
| LastViewedDate | dateTime | Filter, Nillable, Sort | 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 | reference | Create, Filter, Group, Nillable, Sort, Update | A reference to the Location that this employee is assigned to. |
| ManagerId | reference | Create, Filter, Group, Nillable, Sort, Update | A reference to the Employee record of the employee's manager. |
| MediumPhotoUrl | url | Filter, Nillable, Sort | Read only. The URL for the medium-sized employee's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. Available in API v51.0 and later. |
| MiddleName | string | Create, Filter, Group, Nillable, Sort, Update | The employee’s middle name. |
| Name | string | Filter, Group, idLookup, Nillable, Sort | A compound field of Employee.FirstName, Employee.MiddleName, and Employee.LastName. |
| NameSuffix | string | Create, Filter, Group, Nillable, Sort, Update | The employee’s suffix. |
| OutOfOfficeMessage | string | Create, Filter, Group, Nillable, Sort, Update | The message portion of the employee availability. This message can provide reasons or details about the change in availability. The maximum length of this string is 40 characters. |
| OwnerId | reference | Create, Defaulted on create, Filter, Group, Sort, Update | The ID of the user who currently owns this record. Default value is the user logged in to the API to perform the create operation. |
| PreferredFirstName | string | Create, Filter, Group, Nillable, Sort, Update | The name the employee prefers to be called. |
| PreferredPronoun | picklist | Create, Filter, Group, Nillable, Sort, Update | The employee's preferred pronoun.Possible values are: <ul><li>He/Him/His</li><li>Other/Ask Me</li><li>She/Her/Hers</li><li>They/Them/Theirs</li></ul> |
| RelatedPersonId | reference | Create, Filter, Group, Nillable, Sort, Update | Links an employee to a person account with a unique value. Reserved for future use. Don’t edit it. |
| SmallPhotoUrl | url | Filter, Nillable, Sort | Read only. The URL for the small-sized employee's profile photo. The URL is updated every time a photo is uploaded and reflects the most recent photo. If a newer photo has been uploaded, the URL returned for an older photo isn’t guaranteed to return a photo. Query this field for the URL of the most recent photo. Available in API v51.0 and later. |
| StatusAsOf | dateTime | Create, Filter, Sort, Update | Required. Start date of the employee’s current status. |
| StatusEndDate | dateTime | Create, Filter, Nillable, Sort, Update | Planned end date for the employee’s status. |
| TimeZone | picklist | Create, Filter, Group, Nillable, Restricted picklist, Sort, Update | The time zone which the employee’s work hours fall within. |
| UserId | reference | Create, Filter, Group, Nillable, Sort, Update | Lookup field to associate an Employee record with a user in the org. The field is optional and unique. |
| WorkPhone | phone | Create, Filter, Group, Nillable, Sort, Update | The employee's formatted work phone number including country code and extension. |
| WorkerType | picklist | Create, Filter, Group, Restricted picklist, Sort, Update | Required. The type of worker for the employee.Possible values are: <ul><li>Alumnus</li><li>Contractor</li><li>Employee</li><li>Intern</li><li>Temporary</li></ul> |
| WorkingHoursEnd | picklist | Create, Filter, Group, Nillable, Restricted picklist, Sort, Update | The end time of the employee’s working hours. |
| WorkingHoursStart | picklist | Create, Filter, Group, Nillable, Restricted picklist, Sort, Update | The start time of the employee’s working hours. |
Associated Objects
This object has the following associated objects. Unless noted, they’re available in the same API version as this object.
-
EmployeeHistory (API version 49.0)
- : History is available for tracked fields of the object.
-
EmployeeOwnerSharingRule
- : Sharing rules are available for the object.
-
EmployeesShare (API version 49.0)
- : Sharing is available for the object.
See Also