| Field | Type | Required | Description | Example |
|---|---|---|---|---|
type |
Optional[models.PersonMetadataType] | ➖ | N/A | FULL_TIME |
first_name |
Optional[str] | ➖ | The first name of the person | |
last_name |
Optional[str] | ➖ | The last name of the person | |
title |
Optional[str] | ➖ | Job title. | |
business_unit |
Optional[str] | ➖ | Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. | |
department |
Optional[str] | ➖ | An organizational unit where everyone has a similar task, e.g. Engineering. |
|
teams |
List[models.PersonTeam] | ➖ | Info about the employee's team(s). | |
department_count |
Optional[int] | ➖ | The number of people in this person's department. | |
email |
Optional[str] | ➖ | The user's primary email address | |
alias_emails |
List[str] | ➖ | Additional email addresses of this user beyond the primary, if any. | |
location |
Optional[str] | ➖ | User facing string representing the person's location. | |
structured_location |
Optional[models.StructuredLocation] | ➖ | Detailed location with information about country, state, city etc. | |
external_profile_link |
Optional[str] | ➖ | Link to a customer's internal profile page. This is set to '#' when no link is desired. | |
manager |
Optional[models.Person] | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
management_chain |
List[models.Person] | ➖ | The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. | |
phone |
Optional[str] | ➖ | Phone number as a number string. | |
timezone |
Optional[str] | ➖ | The timezone of the person. E.g. "Pacific Daylight Time". | |
timezone_offset |
Optional[int] | ➖ | The offset of the person's timezone in seconds from UTC. | |
timezone_iana |
Optional[str] | ➖ | The IANA timezone identifier, e.g. "America/Los_Angeles". | |
photo_url |
Optional[str] | ➖ | The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). | |
unedited_photo_url |
Optional[str] | ➖ | The original photo URL of the person's avatar before any edits they made are applied | |
banner_url |
Optional[str] | ➖ | The URL of the person's banner photo. | |
reports |
List[models.Person] | ➖ | N/A | |
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. | |
org_size_count |
Optional[int] | ➖ | The total recursive size of the people reporting to this person, or 1 | |
direct_reports_count |
Optional[int] | ➖ | The total number of people who directly report to this person, or 0 | |
preferred_name |
Optional[str] | ➖ | The preferred name of the person, or a nickname. | |
social_network |
List[models.SocialNetwork] | ➖ | List of social network profiles. | |
datasource_profile |
List[models.DatasourceProfile] | ➖ | List of profiles this user has in different datasources / tools that they use. | |
query_suggestions |
Optional[models.QuerySuggestionList] | ➖ | N/A | |
people_distance |
List[models.PersonDistance] | ➖ | List of people and distances to those people from this person. Optionally with metadata. | |
invite_info |
Optional[models.InviteInfo] | ➖ | Information regarding the invite status of a person. | |
is_signed_up |
Optional[bool] | ➖ | Whether the user has signed into Glean at least once. | |
last_extension_use |
date | ➖ | The last time the user has used the Glean extension in ISO 8601 format. | |
permissions |
Optional[models.Permissions] | ➖ | Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes. |
|
custom_fields |
List[models.CustomFieldData] | ➖ | User customizable fields for additional people information. | |
logging_id |
Optional[str] | ➖ | The logging id of the person used in scrubbed logs, tracking GA metrics. | |
start_date_percentile |
Optional[float] | ➖ | Percentage of the company that started strictly after this person. Between [0,100). | |
busy_events |
List[models.AnonymousEvent] | ➖ | Intervals of busy time for this person, along with the type of event they're busy with. | |
profile_bool_settings |
Dict[str, bool] | ➖ | flag settings to indicate user profile settings for certain items | |
badges |
List[models.Badge] | ➖ | The badges that a user has earned over their lifetime. | |
is_org_root |
Optional[bool] | ➖ | Whether this person is a "root" node in their organization's hierarchy. |