Employees

The employee objects allow you to keep your employee's data in a single place.

The API allows you to create, delete, and update your employees. You can retrieve individual employees as well as a list of all your employees.

Here is the list of all properties the employee object has:

Property	Type	Required	Description
name	string	true	The full name of the employee.
email	string	true	The email address of the employee.
phone	string	false	The primary phone number of the employee.
twitterHandle	string	false	The twitter handle of the employee.
team	Team	false	Reference to the team the employee belongs to.
contactPerson	boolean	false	True if the employee is a contact person in his company.
billingPerson	boolean	false	True if the employee is the billing person of his company and receives all the invoices.
office	Location	false	Reference to the location the employee belongs to. It will default to the only location if left empty.
paymentDetails	array	readonly	Array containing all the names of the payment details added to the employee account.
createdAt	date	readonly	The date when the employee has been created at.
createdBy	id	readonly	The user that created the employee.
modifiedAt	date	readonly	The date when the employee has been modified for the last time. If no update is made this field will match the `createdAt` field.
modifiedBy	id	readonly	The user that did the last modification to the employee. If no update is made this field will match the `createdBy` field.
status	enum	false	The employee status. It could be active, contact or former.
calculatedStatus	enum	readonly	The actual employee status calculated by the platform. Please, refer to this article for more information.