Employee.md

Employee

The Employee Object ### Description The Employee object is used to represent an Employee for a company. ### Usage Example Fetch from the LIST Employee endpoint and filter by ID to show all employees.

Properties

Name	Type	Description	Notes
id	UUID		[optional] [readonly]
remoteId	String	The third-party API ID of the matching object.	[optional]
employeeNumber	String	The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers.	[optional]
company	UUID		[optional]
firstName	String	The employee's first name.	[optional]
lastName	String	The employee's last name.	[optional]
displayFullName	String	The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.	[optional]
groups	List<UUID>		[optional]
workEmail	String	The employee's work email.	[optional]
personalEmail	String	The employee's personal email.	[optional]
mobilePhoneNumber	String	The employee's mobile phone number.	[optional]
employments	List<UUID>	Array of `Employment` IDs for this Employee.	[optional]
homeLocation	UUID		[optional]
workLocation	UUID		[optional]
manager	UUID		[optional]
team	UUID		[optional]
payGroup	UUID		[optional]
ssn	String	The employee's social security number.	[optional]
gender	GenderEnum	The employee's gender.	[optional]
ethnicity	EthnicityEnum	The employee's ethnicity.	[optional]
maritalStatus	MaritalStatusEnum	The employee's marital status.	[optional]
dateOfBirth	OffsetDateTime	The employee's date of birth.	[optional]
hireDate	OffsetDateTime	The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.	[optional]
startDate	OffsetDateTime	The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date.	[optional]
employmentStatus	EmploymentStatusEnum	The employment status of the employee.	[optional]
terminationDate	OffsetDateTime	The employee's termination date.	[optional]
avatar	URI	The URL of the employee's avatar image.	[optional]
remoteData	List<RemoteData>		[optional] [readonly]
customFields	Map<String, Object>	Custom fields configured for a given model.	[optional]
remoteWasDeleted	Boolean		[optional] [readonly]