EmployeeInfoDefinition
Describes employee info
Properties
Name | Type | Description | Notes |
---|---|---|---|
str | The employee's email | ||
department | str | An organizational unit where everyone has a similar task, e.g. `Engineering`. | |
first_name | str | The first name of the employee. Note: The value cannot be empty | [optional] |
last_name | str | The last name of the employee. Note: The value cannot be empty | [optional] |
preferred_name | str | The preferred name or nickname of the employee | [optional] |
id | str | [Advanced] A unique universal internal identifier for the employee. This is solely used for understanding manager relationships along with `managerId`. | [optional] |
phone_number | str | The employee's phone number. | [optional] |
location | str | The employee's location (city/office name etc). | [optional] |
structured_location | StructuredLocation | [optional] | |
title | str | The employee's role title. | [optional] |
photo_url | str | The employee's profile pic | [optional] |
business_unit | str | Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. | [optional] |
datasource_profiles | [DatasourceProfile] | The datasource profiles of the employee, e.g. `Slack`,`Github`. | [optional] |
teams | [EmployeeTeamInfo] | Info about the employee's team(s) | [optional] |
start_date | date | The date when the employee started | [optional] |
end_date | date | If a former employee, the last date of employment. | [optional] |
bio | str | Short biography or mission statement of the employee. | [optional] |
pronoun | str | She/her, He/his or other pronoun. | [optional] |
also_known_as | [str] | Other names associated with the employee. | [optional] |
profile_url | str | Link to internal company person profile. | [optional] |
social_networks | [SocialNetworkDefinition] | List of social network profiles. | [optional] |
manager_email | str | The email of the employee's manager | [optional] |
manager_id | str | [Advanced] A unique universal internal identifier for the employee's manager. This is solely used in conjunction with `id`. | [optional] |
type | str | The type of the employee, an enum of `FULL_TIME`, `CONTRACTOR`, `NON_EMPLOYEE` | [optional] if omitted the server will use the default value of "FULL_TIME" |
relationships | [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. | [optional] |
status | str | The status of the employee, an enum of `CURRENT`, `FUTURE`, `EX` | [optional] if omitted the server will use the default value of "CURRENT" |
additional_fields | [AdditionalFieldDefinition] | List of additional fields with more information about the employee. | [optional] |
any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |