employeeinfodefinition.md

EmployeeInfoDefinition

Describes employee info

Fields

Field	Type	Required	Description
email	str	✔️	The employee's email
first_name	Optional[str]	➖	The first name of the employee. Note: The value cannot be empty
last_name	Optional[str]	➖	The last name of the employee. Note: The value cannot be empty
preferred_name	Optional[str]	➖	The preferred name or nickname of the employee
id	Optional[str]	➖	[Advanced] A unique universal internal identifier for the employee. This is solely used for understanding manager relationships along with managerId.
phone_number	Optional[str]	➖	The employee's phone number.
location	Optional[str]	➖	: warning: ** DEPRECATED **: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated. The employee's location (city/office name etc).
structured_location	Optional[models.StructuredLocation]	➖	Detailed location with information about country, state, city etc.
title	Optional[str]	➖	The employee's role title.
photo_url	Optional[str]	➖	The employee's profile pic
business_unit	Optional[str]	➖	Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
department	str	✔️	An organizational unit where everyone has a similar task, e.g. Engineering.
datasource_profiles	List[models.DatasourceProfile]	➖	The datasource profiles of the employee, e.g. Slack,Github.
teams	List[models.EmployeeTeamInfo]	➖	Info about the employee's team(s)
start_date	datetime	➖	The date when the employee started
end_date	datetime	➖	If a former employee, the last date of employment.
bio	Optional[str]	➖	Short biography or mission statement of the employee.
pronoun	Optional[str]	➖	She/her, He/his or other pronoun.
also_known_as	List[str]	➖	Other names associated with the employee.
profile_url	Optional[str]	➖	Link to internal company person profile.
social_networks	List[models.SocialNetworkDefinition]	➖	List of social network profiles.
manager_email	Optional[str]	➖	The email of the employee's manager
manager_id	Optional[str]	➖	[Advanced] A unique universal internal identifier for the employee's manager. This is solely used in conjunction with id.
type	Optional[str]	➖	The type of the employee, an enum of FULL_TIME, CONTRACTOR, NON_EMPLOYEE
relationships	List[models.EntityRelationship]	➖	List of unidirectional relationships with other employees. E.g. this employee (A) is a CHIEF_OF_STAFF to another employee (B); or this employee (A) is an EXECUTIVE_ASSISTANT of another employee (C). The mapping should be attached to A's profile.
status	Optional[str]	➖	The status of the employee, an enum of CURRENT, FUTURE, EX
additional_fields	List[models.AdditionalFieldDefinition]	➖	List of additional fields with more information about the employee.