--- title: "Retrieves a Chat" method: POST path: "/rest/api/v1/getchat" tags: ["Chat"] --- # Retrieves a Chat `POST /rest/api/v1/getchat` Retrieves the chat history between Glean Assistant and the user for a given Chat. ## Query parameters - `locale` string - `timezoneOffset` integer ## Request body - GetChatRequest - `id` string, required — The id of the Chat to be retrieved. ## Response `200` OK - GetChatResponse - `chatResult` ChatResult - `chat` Chat — Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content. - `id` string — The opaque id of the Chat. - `createTime` integer — Server Unix timestamp of the creation time (in seconds since epoch UTC). - `createdBy` Person - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - `relation` 'ATTACHMENT' | 'CANONICAL' | 'CASE' | 'contact' | 'CONTACT' | 'CONVERSATION_MESSAGES' | 'EXPERT' | 'FROM' | 'HIGHLIGHT' | 'opportunity' | 'OPPORTUNITY' | 'RECENT' | 'SOURCE' | 'TICKET' | 'TRANSCRIPT' | 'WITH' — How this document relates to the including entity. - `associatedEntityId` string — Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - `querySuggestion` QuerySuggestion - `missingTerm` string — A query term missing from the original query on which this suggestion is based. - `query` string, required — The query being suggested (e.g. enforcing the missing term from the original query). - `searchProviderInfo` SearchProviderInfo - … - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - … - `requestOptions` SearchRequestOptions - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - … - `inputDetails` SearchRequestInputDetails - … - `documents` Document[] — A truncated list of documents with this relation. TO BE DEPRECATED. - `id` string — The Glean Document ID. - `datasource` string — The app or other repository type from which the document was extracted - `connectorType` 'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY' — The source from which document content was pulled, e.g. an API crawl or browser history - `docType` string — The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `content` DocumentContent - … - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - … - `sections` DocumentSection[] — A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - … - `results` SearchResult[] — A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - `structuredResults` StructuredResult[] — An array of entities in the work graph retrieved via a data request. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `document` Document - … - `title` string - `url` string, required - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - `snippets` SearchResultSnippet[] — Text content from the result document which contains search query terms, if available. - … - `fullText` string — The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). - `fullTextList` string[] — The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). - `relatedResults` RelatedDocuments[] — A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `allClusteredResults` ClusterGroup[] — A list of results that should be displayed as associated with this result. - … - `attachmentCount` integer — The total number of attachments. - `attachments` SearchResult[] — A (potentially partial) list of results representing documents attached to the main result document. - `backlinkResults` SearchResult[] — A list of results that should be displayed as backlinks of this result in reverse chronological order. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `mustIncludeSuggestions` QuerySuggestionList - … - `querySuggestion` QuerySuggestion - … - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `attachmentContext` string — Additional context for the relationship between the result and the document it's attached to. - `pins` PinDocument[] — A list of pins associated with this search result. - … - `metadata` PersonMetadata - `type` 'FULL_TIME' | 'CONTRACTOR' | 'NON_EMPLOYEE' | 'FORMER_EMPLOYEE' - `firstName` string — The first name of the person - `lastName` string — The last name of the person - `title` string — Job title. - `businessUnit` string — Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - `department` string — An organizational unit where everyone has a similar task, e.g. `Engineering`. - `jobFunction` string — Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive. - `teams` PersonTeam[] — Info about the employee's team(s). - `id` string — Unique identifier - `name` string — Team name - `externalLink` string, uri — Link to a team page on the internet or your company's intranet - `relationship` 'MEMBER' | 'MANAGER' | 'LEAD' | 'POINT_OF_CONTACT' | 'OTHER' — The team member's relationship to the team. This defaults to MEMBER if not set. - `joinDate` string, date-time — The team member's start date - `departmentCount` integer — The number of people in this person's department. - `email` string — The user's primary email address - `aliasEmails` string[] — Additional email addresses of this user beyond the primary, if any. - `location` string — User facing string representing the person's location. - `structuredLocation` StructuredLocation — Detailed location with information about country, state, city etc. - `deskLocation` string — Desk number. - `timezone` string — Location's timezone, e.g. UTC, PST. - `address` string — Office address or name. - `city` string — Name of the city. - `state` string — State code. - `region` string — Region information, e.g. NORAM, APAC. - `zipCode` string — ZIP Code for the address. - `country` string — Country name. - `countryCode` string — Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - `externalProfileLink` string — Link to a customer's internal profile page. This is set to '#' when no link is desired. - `manager` Person — recursive - `managementChain` Person[] — The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - `phone` string — Phone number as a number string. - `timezone` string — The timezone of the person. E.g. "Pacific Daylight Time". - `timezoneOffset` integer — The offset of the person's timezone in seconds from UTC. - `timezoneIANA` string — The IANA timezone identifier, e.g. "America/Los_Angeles". - `photoUrl` string, url — The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - `uneditedPhotoUrl` string, url — The original photo URL of the person's avatar before any edits they made are applied - `bannerUrl` string, url — The URL of the person's banner photo. - `reports` Person[] - `startDate` string, date — The date when the employee started. - `endDate` string, date — If a former employee, the last date of employment. - `bio` string — Short biography or mission statement of the employee. - `pronoun` string — She/her, He/his or other pronoun. - `orgSizeCount` integer — The total recursive size of the people reporting to this person, or 1 - `directReportsCount` integer — The total number of people who directly report to this person, or 0 - `preferredName` string — The preferred name of the person, or a nickname. - `socialNetwork` SocialNetwork[] — List of social network profiles. - `name` string, required — Possible values are "twitter", "linkedin". - `profileName` string — Human-readable profile name. - `profileUrl` string, url, required — Link to profile. - `datasourceProfile` DatasourceProfile[] — List of profiles this user has in different datasources / tools that they use. - `datasource` string, required — The datasource the profile is of. - `handle` string, required — The display name of the entity in the given datasource. - `url` string — URL to view the entity's profile. - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - `isUserGenerated` boolean — For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source) - `querySuggestions` QuerySuggestionList - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `peopleDistance` PersonDistance[] — List of people and distances to those people from this person. Optionally with metadata. - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `distance` number, float, required — Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - `inviteInfo` InviteInfo — Information regarding the invite status of a person. - `signUpTime` string, date-time — The time this person signed up in ISO format (ISO 8601). - `invites` ChannelInviteInfo[] — Latest invites received by the user for each channel - … - `inviter` Person — recursive - `inviteTime` string, date-time — The time this person was invited in ISO format (ISO 8601). - `reminderTime` string, date-time — The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - `isSignedUp` boolean — Whether the user has signed into Glean at least once. - `lastExtensionUse` string, date-time — The last time the user has used the Glean extension in ISO 8601 format. - `permissions` 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. - `canAdminSearch` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - `canAdminClientApiGlobalTokens` boolean — TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - `canDlp` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - `read` unknown - `write` unknown - `grant` unknown - `role` string — The roleId of the canonical role a user has. The displayName is equal to the roleId. - `roles` string[] — The roleIds of the roles a user has. - `customFields` CustomFieldData[] — User customizable fields for additional people information. - `label` string, required — A user-facing label for this field. - `values` CustomFieldValue[], required - … - `displayable` boolean, required — Determines whether the client should display this custom field - `loggingId` string — The logging id of the person used in scrubbed logs, tracking GA metrics. - `startDatePercentile` number, float — Percentage of the company that started strictly after this person. Between [0,100). - `busyEvents` AnonymousEvent[] — Intervals of busy time for this person, along with the type of event they're busy with. - `time` TimeInterval - … - `eventType` 'DEFAULT' | 'OUT_OF_OFFICE' — The nature of the event, for example "out of office". - `profileBoolSettings` object — flag settings to indicate user profile settings for certain items - `badges` Badge[] — The badges that a user has earned over their lifetime. - `key` string — An auto generated unique identifier. - `displayName` string — The badge name displayed to users - `iconConfig` IconConfig — Defines how to render an icon - … - `pinned` boolean — The badge should be shown on the PersonAttribution - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `updateTime` integer — Server Unix timestamp of the update time (in seconds since epoch UTC). - `name` string — The name of the Chat. - `applicationId` string — The ID of the AI App that this Chat is associated to. - `applicationName` string — The display name of the AI App that this Chat is associated to. - `icon` IconConfig — Defines how to render an icon - `generatedBackgroundColorKey` string - `backgroundColor` string - `color` string - `key` string - `iconType` 'COLLECTION' | 'CUSTOM' | 'DATASOURCE' | 'DATASOURCE_INSTANCE' | 'FAVICON' | 'FILE_TYPE' | 'GENERATED_BACKGROUND' | 'GLYPH' | 'MIME_TYPE' | 'NO_ICON' | 'PERSON' | 'REACTIONS' | 'URL' - `masked` boolean — Whether the icon should be masked based on current theme. - `name` string — The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - `url` string — The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - `permissions` ObjectPermissions - `write` WritePermission — Describes the write permissions levels that a user has for a specific feature - `scopeType` 'GLOBAL' | 'OWN' — Describes the scope for a ReadPermission, WritePermission, or GrantPermission object - `create` boolean — True if user has create permission for this feature and scope - `update` boolean — True if user has update permission for this feature and scope - `delete` boolean — True if user has delete permission for this feature and scope - `messages` ChatMessage[] — The chat messages within a Chat. - `agentConfig` AgentConfig — Describes the agent that executes the request. - `agent` 'DEFAULT' | 'GPT' | 'UNIVERSAL' | 'FAST' | 'ADVANCED' | 'AUTO' — Name of the agent. - `toolSets` ToolSets — The types of tools that the agent is allowed to use. Only works with FAST and ADVANCED `agent` values - `enableWebSearch` boolean — Whether the agent is allowed to use web search (default: true). - `enableCompanyTools` boolean — Whether the agent is allowed to search internal company resources (default: true). - `mode` 'DEFAULT' | 'QUICK' — Top level modes to run GleanChat in. - `useImageGeneration` boolean — Whether the agent should create an image. - `author` 'USER' | 'GLEAN_AI' - `citations` ChatMessageCitation[] — Deprecated: Use inline citations via ChatMessageFragment.citation instead. For detailed reference information, use ChatMessageCitation.referenceRanges. This field is still populated for backward compatibility. - `trackingToken` string — An opaque token that represents this particular result in this particular ChatMessage. To be used for /feedback reporting. - `sourceDocument` Document - `id` string — The Glean Document ID. - `datasource` string — The app or other repository type from which the document was extracted - `connectorType` 'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY' — The source from which document content was pulled, e.g. an API crawl or browser history - `docType` string — The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `content` DocumentContent - … - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - … - `sections` DocumentSection[] — A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - … - `sourceFile` ChatFile — Structure for file uploaded by a user for Chat. - `id` string — Unique identifier of the file. - `url` string — Url of the file. - `name` string — Name of the uploaded file. - `metadata` ChatFileMetadata — Metadata of a file uploaded by a user for Chat. - … - `sourcePerson` Person - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - … - `metadata` PersonMetadata - … - `sourceCustomEntity` CustomEntity - `permissions` ObjectPermissions - … - `id` string — Unique identifier. - `title` string — Title or name of the custom entity. - `datasource` string — The datasource the custom entity is from. - `objectType` string — The type of the entity. Interpretation is specific to each datasource - `metadata` CustomEntityMetadata - … - `roles` UserRoleSpecification[] — A list of user roles for the custom entity explicitly granted by the owner. - … - `referenceRanges` ReferenceRange[] — Each reference range and its corresponding snippets - `textRange` TextRange — A subsection of a given string to which some special formatting should be applied. - … - `snippets` SearchResultSnippet[] - … - `uploadedFileIds` string[] — IDs of files uploaded in the message that are referenced to generate the answer. - `fragments` ChatMessageFragment[] — A list of rich data used to represent the response or formulate a request. These are linearly stitched together to support richer data formats beyond simple text. - `structuredResults` StructuredResult[] — An array of entities in the work graph retrieved via a data request. - `document` Document - … - `person` Person - … - `customer` Customer - … - `team` Team - … - `customEntity` CustomEntity - … - `answer` Answer - … - `generatedQna` GeneratedQna - … - `extractedQnA` ExtractedQnA - … - `meeting` Meeting - … - `app` AppResult - … - `collection` Collection - … - `code` Code - … - `shortcut` Shortcut - … - `querySuggestions` QuerySuggestionList - … - `chat` ChatMetadata — Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content. - … - `relatedDocuments` RelatedDocuments[] — A list of documents related to this structured result. - … - `relatedQuestion` RelatedQuestion - … - `disambiguation` Disambiguation — A disambiguation between multiple entities with the same name - … - `snippets` SearchResultSnippet[] — Any snippets associated to the populated object. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `source` 'EXPERT_DETECTION' | 'ENTITY_NLQ' | 'CALENDAR_EVENT' | 'AGENT' — Source context for this result. Possible values depend on the result type. - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `text` string - `querySuggestion` QuerySuggestion - `missingTerm` string — A query term missing from the original query on which this suggestion is based. - `query` string, required — The query being suggested (e.g. enforcing the missing term from the original query). - `searchProviderInfo` SearchProviderInfo - … - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - … - `requestOptions` SearchRequestOptions - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - … - `inputDetails` SearchRequestInputDetails - … - `file` ChatFile — Structure for file uploaded by a user for Chat. - `id` string — Unique identifier of the file. - `url` string — Url of the file. - `name` string — Name of the uploaded file. - `metadata` ChatFileMetadata — Metadata of a file uploaded by a user for Chat. - … - `action` ToolInfo - `metadata` ToolMetadata — The manifest for a tool that can be used to augment Glean Assistant. - … - `parameters` object — Parameters supported by the tool. - `citation` ChatMessageCitation — Information about the source for a ChatMessage. - `trackingToken` string — An opaque token that represents this particular result in this particular ChatMessage. To be used for /feedback reporting. - `sourceDocument` Document - … - `sourceFile` ChatFile — Structure for file uploaded by a user for Chat. - … - `sourcePerson` Person - … - `sourceCustomEntity` CustomEntity - … - `referenceRanges` ReferenceRange[] — Each reference range and its corresponding snippets - … - `serverToolRequest` ServerToolRequest - `requestType` 'EXECUTION' | 'AUTHENTICATION_SUGGESTION' | 'VOTE_SUGGESTION', required — The type of request made to the user. - `requestId` string, required — Unique identifier for this request. - `toolDisplayName` string — Human-readable display name for the tool. - `serverId` string — Unique identifier of the tool server. Use with GET /tool-servers/{serverId}/auth to resolve display information and authentication status. - `toolCta` string — Custom call-to-action (CTA) verb for the approval button (e.g., "Create", "Update", "Send"). - `actionPreview` ActionPreview — Preview information for an action being executed. - … - `serverToolResponse` ServerToolResponse — Response to a server tool request. The applicable fields depend on requestType: For EXECUTION requests: - isGranted: whether tool execution is approved - reason: optional explanation For AUTHENTICATION_SUGGESTION requests: - isGranted: whether auth completed successfully (true=connected, false=skipped) - authContext: contains serverId or actionPackId for identifying the authenticated entity - reason: optional explanation for skip For VOTE_SUGGESTION requests: - voted: whether the user voted for this tool - `requestType` 'EXECUTION' | 'AUTHENTICATION_SUGGESTION' | 'VOTE_SUGGESTION', required — The type of request made to the user. - `requestId` string, required — Unique identifier for this request. - `isGranted` boolean — Whether tool request is granted (indicates approval for execution, or completion for auth). - `grantScope` 'CURRENT_REQUEST' | 'CURRENT_SESSION' | 'ALWAYS' — Scope of the approval grant. Only applicable when isGranted is true and requestType is EXECUTION. - `authContext` AuthContext — Context for authentication responses, containing identifiers for the entity being authenticated. - … - `ts` string — Response timestamp of the message. - `messageId` string — A unique server-side generated ID used to identify a message, automatically populated for any USER authored messages. - `messageTrackingToken` string — Opaque tracking token generated server-side. - `messageType` 'UPDATE' | 'CONTENT' | 'CONTEXT' | 'CONTROL' | 'CONTROL_START' | 'CONTROL_FINISH' | 'CONTROL_CANCEL' | 'CONTROL_RETRY' | 'CONTROL_UNKNOWN' | 'DEBUG' | 'DEBUG_EXTERNAL' | 'ERROR' | 'HEADING' | 'WARNING' | 'SERVER_TOOL' — Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. - `hasMoreFragments` boolean — Signals there are additional response fragments incoming. - `roles` UserRoleSpecification[] — A list of roles for this Chat. - `sourceDocumentSpec` union - object - `url` string, required — The URL of the document. - object - `id` string, required — The ID of the document. - object - `ugcType` 'ANNOUNCEMENTS' | 'ANSWERS' | 'COLLECTIONS' | 'SHORTCUTS' | 'CHATS', required — The type of the user generated content (UGC datasource). - `contentId` integer, required — The numeric id for user generated content. Used for ANNOUNCEMENTS, ANSWERS, COLLECTIONS, SHORTCUTS. - `docType` string — The specific type of the user generated content type. - object - `ugcType` 'ANNOUNCEMENTS' | 'ANSWERS' | 'ARTIFACTS' | 'COLLECTIONS' | 'SHORTCUTS' | 'CHATS', required — The type of the user generated content (UGC datasource). - `ugcId` string, required — The string id for user generated content. Used for CHATS. - `docType` string — The specific type of the user generated content type. - `person` Person - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - `relation` 'ATTACHMENT' | 'CANONICAL' | 'CASE' | 'contact' | 'CONTACT' | 'CONVERSATION_MESSAGES' | 'EXPERT' | 'FROM' | 'HIGHLIGHT' | 'opportunity' | 'OPPORTUNITY' | 'RECENT' | 'SOURCE' | 'TICKET' | 'TRANSCRIPT' | 'WITH' — How this document relates to the including entity. - `associatedEntityId` string — Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - `querySuggestion` QuerySuggestion - … - `documents` Document[] — A truncated list of documents with this relation. TO BE DEPRECATED. - … - `results` SearchResult[] — A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - … - `metadata` PersonMetadata - `type` 'FULL_TIME' | 'CONTRACTOR' | 'NON_EMPLOYEE' | 'FORMER_EMPLOYEE' - `firstName` string — The first name of the person - `lastName` string — The last name of the person - `title` string — Job title. - `businessUnit` string — Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - `department` string — An organizational unit where everyone has a similar task, e.g. `Engineering`. - `jobFunction` string — Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive. - `teams` PersonTeam[] — Info about the employee's team(s). - … - `departmentCount` integer — The number of people in this person's department. - `email` string — The user's primary email address - `aliasEmails` string[] — Additional email addresses of this user beyond the primary, if any. - `location` string — User facing string representing the person's location. - `structuredLocation` StructuredLocation — Detailed location with information about country, state, city etc. - … - `externalProfileLink` string — Link to a customer's internal profile page. This is set to '#' when no link is desired. - `manager` Person — recursive - `managementChain` Person[] — The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - `phone` string — Phone number as a number string. - `timezone` string — The timezone of the person. E.g. "Pacific Daylight Time". - `timezoneOffset` integer — The offset of the person's timezone in seconds from UTC. - `timezoneIANA` string — The IANA timezone identifier, e.g. "America/Los_Angeles". - `photoUrl` string, url — The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - `uneditedPhotoUrl` string, url — The original photo URL of the person's avatar before any edits they made are applied - `bannerUrl` string, url — The URL of the person's banner photo. - `reports` Person[] - `startDate` string, date — The date when the employee started. - `endDate` string, date — If a former employee, the last date of employment. - `bio` string — Short biography or mission statement of the employee. - `pronoun` string — She/her, He/his or other pronoun. - `orgSizeCount` integer — The total recursive size of the people reporting to this person, or 1 - `directReportsCount` integer — The total number of people who directly report to this person, or 0 - `preferredName` string — The preferred name of the person, or a nickname. - `socialNetwork` SocialNetwork[] — List of social network profiles. - … - `datasourceProfile` DatasourceProfile[] — List of profiles this user has in different datasources / tools that they use. - … - `querySuggestions` QuerySuggestionList - … - `peopleDistance` PersonDistance[] — List of people and distances to those people from this person. Optionally with metadata. - … - `inviteInfo` InviteInfo — Information regarding the invite status of a person. - … - `isSignedUp` boolean — Whether the user has signed into Glean at least once. - `lastExtensionUse` string, date-time — The last time the user has used the Glean extension in ISO 8601 format. - `permissions` 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. - … - `customFields` CustomFieldData[] — User customizable fields for additional people information. - … - `loggingId` string — The logging id of the person used in scrubbed logs, tracking GA metrics. - `startDatePercentile` number, float — Percentage of the company that started strictly after this person. Between [0,100). - `busyEvents` AnonymousEvent[] — Intervals of busy time for this person, along with the type of event they're busy with. - … - `profileBoolSettings` object — flag settings to indicate user profile settings for certain items - `badges` Badge[] — The badges that a user has earned over their lifetime. - … - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `group` Group - `type` 'DEPARTMENT' | 'ALL' | 'TEAM' | 'JOB_TITLE' | 'ROLE_TYPE' | 'LOCATION' | 'REGION' | 'EXTERNAL_GROUP' | 'COLLECTION_AUDIENCE', required — The type of user group - `id` string, required — A unique identifier for the group. May be the same as name. - `name` string — Name of the group. - `datasourceInstance` string — Datasource instance if the group belongs to one e.g. external groups. - `provisioningId` string — identifier for greenlist provisioning, aka sciokey - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `trackingToken` string — An opaque token that represents this particular Chat. To be used for `/feedback` reporting. ## Other responses - `400` — Invalid request - `401` — Not Authorized - `403` — Forbidden - `429` — Too Many Requests --- [API](https://skmtc.net/gleanwork/apis/glean-api.md) · [All operations](https://skmtc.net/gleanwork/apis/glean-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gleanwork/glean-api/revisions/ebd602e4aea4/schema)