Employee

Represents an employee within a company or organization.

Introduced in API version 48.0.

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.

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

  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: 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.
  • Type: email
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s alternate email address.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The employee’s availability status.
  • Possible values:
    • In The Office — In The Office
    • Out Of Office — Out Of Office
    • Out Sick — Out Sick
    • PTO — PTO
    • Volunteering Time Off — Volunteering Time Off
    • Working Remotely — Working Remotely
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The end date of the Employee’s availability, inclusive of the date.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The start date of the Employee’s availability, inclusive of the date.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 51.0

  • Relationship name: BannerPhoto

  • Relationship type: relationship

  • Refers to: Photo

  • Type: url
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 51.0
  • Description: Read only. The URL for the employee’s banner photo. Available in API v51.0 and later.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s current wellness status.
  • Possible values:
    • Available To Work — Available To Work
    • Remote Work Only — Remote Work Only
    • Unavailable — Unavailable
    • Unknown — Unknown
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s date of birth.
  • Type: email
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: The employee’s email address. This field is unique within your organization.
  • 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.
  • Type: picklist
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Required. The employee’s current work status.
  • Possible values:
    • Active — Active
    • Inactive — Inactive
    • Leave — Leave
    • Terminated — Terminated
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s full-time or part-time status.
  • Possible values:
    • Full-Time — Full-Time
    • Part-Time — Part-Time
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Required. The employee’s first name.
  • Type: url
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 51.0
  • Description: 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.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s gender.
  • Possible values:
    • Female — Female
    • Male — Male
    • Non-Binary / Non-Conforming — Non-Binary / Non-Conforming
    • Other — Other
    • Prefer Not to State — Prefer Not to State
    • Transgender Female — Transgender Female
    • Transgender Male — Transgender Male
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Type: address
  • Properties: Filter, Nillable
  • Description: The employee’s home address.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city for the employee’s home address.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The county for the employee’s home address.
  • Type: string
  • Properties: Create, Nillable, Update
  • 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:
    • Address — Address
    • Block — Block
    • City — City
    • County — County
    • ExtendedZip — ExtendedZip
    • NearAddress — NearAddress
    • Neighborhood — Neighborhood
    • State — State
    • Street — Street
    • Unknown — Unknown
    • Zip — Zip
  • 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.
  • 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.
  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s home phone number.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code for the employee’s home address.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state for the employee’s home address.
  • Type: string
  • Properties: Create, Nillable, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The street for the employee’s home address.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A reference to the Individual record that this employee is assigned to.
  • Relationship name: Individual
  • Relationship type: relationship
  • Refers to: Individual
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A reference to the InternalOrganizationUnit this employee is assigned to.
  • Relationship name: InternalOrganizationUnit
  • Relationship type: relationship
  • Refers to: InternalOrganizationUnit
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s job profile at the company.
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Required. The employee’s last name.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A reference to the Location that this employee is assigned to.
  • Relationship name: Location
  • Relationship type: relationship
  • Refers to: Location
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A reference to the Employee record of the employee’s manager.
  • Relationship name: Manager
  • Relationship type: relationship
  • Refers to: Employee
  • Type: url
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 51.0
  • Description: 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s middle name.
  • Type: string
  • Properties: Filter, Group, idLookup, Nillable, Sort
  • Description: A compound field of Employee.FirstName, Employee.MiddleName, and Employee.LastName.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s suffix.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name the employee prefers to be called.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s preferred pronoun.
  • Possible values:
    • He/Him/His — He/Him/His
    • Other/Ask Me — Other/Ask Me
    • She/Her/Hers — She/Her/Hers
    • They/Them/Theirs — They/Them/Theirs

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 51.0

  • Relationship name: ProfilePhoto

  • Relationship type: relationship

  • Refers to: Photo

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Links an employee to a person account with a unique value. Reserved for future use. Don’t edit it.
  • Relationship name: RelatedPerson
  • Relationship type: polymorphic
  • Refers to: Account, FtestUser
  • Type: url
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 51.0
  • Description: 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.
  • Type: datetime
  • Properties: Create, Filter, Sort, Update
  • Description: Required. Start date of the employee’s current status.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Planned end date for the employee’s status.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 49.0
  • Description: The time zone which the employee’s work hours fall within.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: Lookup field to associate an Employee record with a user in the org. The field is optional and unique.
  • Relationship name: User
  • Relationship type: relationship
  • Refers to: User
  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The employee’s formatted work phone number including country code and extension.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Required. The type of worker for the employee.
  • Possible values:
    • Alumnus — Alumnus
    • Contractor — Contractor
    • Employee — Employee
    • Intern — Intern
    • Temporary — Temporary
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 49.0
  • Description: The end time of the employee’s working hours.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 49.0
  • Description: The start time of the employee’s working hours.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.