--- title: "Feed of documents and events" method: POST path: "/rest/api/v1/feed" tags: ["Search"] --- # Feed of documents and events `POST /rest/api/v1/feed` The personalized feed/home includes different types of contents including suggestions, recents, calendar events and many more. ## Query parameters - `locale` string ## Request body - FeedRequest - `categories` string[] — Categories of content requested. An allowlist gives flexibility to request content separately or together. - `requestOptions` FeedRequestOptions - `resultSize` integer, required — Number of results asked in response. If a result is a collection, counts as one. - `timezoneOffset` integer — The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC. - `categoryToResultSize` object — Mapping from category to number of results asked for the category. - `datasourceFilter` string[] — Datasources for which content should be included. Empty is for all. - `chatZeroStateSuggestionOptions` ChatZeroStateSuggestionOptions - `applicationId` string — The Chat Application ID this feed request should be scoped to. Empty means there is no Chat Application ID.. - `timeoutMillis` integer — Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer. - `sessionInfo` SessionInfo - `sessionTrackingToken` string — A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab. - `tabId` string — A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab. - `lastSeen` string, date-time — The last time the server saw this token. - `lastQuery` string — The last query seen by the server. ## Response `200` OK - FeedResponse - `experimentIds` integer[] — List of experiment ids for the corresponding request. - `trackingToken` string — An opaque token that represents this particular feed response. - `serverTimestamp` integer, required — Server unix timestamp (in seconds since epoch UTC). - `results` FeedResult[] - `category` 'DOCUMENT_SUGGESTION' | 'DOCUMENT_SUGGESTION_SCENARIO' | 'TRENDING_DOCUMENT' | 'USE_CASE' | 'VERIFICATION_REMINDER' | 'EVENT' | 'ANNOUNCEMENT' | 'MENTION' | 'DATASOURCE_AFFINITY' | 'RECENT' | 'COMPANY_RESOURCE' | 'EXPERIMENTAL' | 'PEOPLE_CELEBRATIONS' | 'SOCIAL_LINK' | 'EXTERNAL_TASKS' | 'DISPLAYABLE_LIST' | 'ZERO_STATE_CHAT_SUGGESTION' | 'ZERO_STATE_CHAT_TOOL_SUGGESTION' | 'ZERO_STATE_WORKFLOW_CREATED_BY_ME' | 'ZERO_STATE_WORKFLOW_FAVORITES' | 'ZERO_STATE_WORKFLOW_POPULAR' | 'ZERO_STATE_WORKFLOW_RECENT' | 'ZERO_STATE_WORKFLOW_SUGGESTION' | 'PERSONALIZED_CHAT_SUGGESTION' | 'DAILY_DIGEST' | 'PODCAST' | 'TASK' | 'PLAN_MY_DAY' | 'END_MY_DAY' | 'STARTER_KIT' | 'MEETING_PREP_AUTOMATION' | 'MID_DAY_CATCH_UP' | 'QUERY_SUGGESTION' | 'COWORK_CUJ_PROMO' | 'CARD_STACK_PROMO' | 'WEEKLY_MEETINGS' | 'FOLLOW_UP' | 'MILESTONE_TIMELINE_CHECK' | 'PROJECT_DISCUSSION_DIGEST' | 'PROJECT_FOCUS_BLOCK' | 'PROJECT_NEXT_STEP' | 'DEMO_CARD' | 'OOO_PLANNER' | 'OOO_CATCH_UP' | 'ADMIN_HEALTH_CENTER', required — Category of the result, one of the requested categories in incoming request. - `primaryEntry` FeedEntry, required - `entryId` string — optional ID associated with a single feed entry (displayable_list_id) - `title` string, required — Title for the result. Can be document title, event title and so on. - `thumbnail` Thumbnail - `photoId` string — Photo id if the thumbnail is from splash. - `url` string — Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - `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. - `uiConfig` object - `format` 'LIST' — defines how to render this particular displayable list card - `additionalFlags` DisplayableListItemUIConfig — UI configurations for each item of the list - `showNewIndicator` boolean — show a "New" pill next to the item - `justificationType` 'FREQUENTLY_ACCESSED' | 'RECENTLY_ACCESSED' | 'TRENDING_DOCUMENT' | 'VERIFICATION_REMINDER' | 'SUGGESTED_DOCUMENT' | 'EMPTY_STATE_SUGGESTION' | 'FRECENCY_SCORED' | 'SERVER_GENERATED' | 'USE_CASE' | 'UPDATE_SINCE_LAST_VIEW' | 'RECENTLY_STARTED' | 'EVENT' | 'USER_MENTION' | 'ANNOUNCEMENT' | 'EXTERNAL_ANNOUNCEMENT' | 'POPULARITY_BASED_TRENDING' | 'COMPANY_RESOURCE' | 'EVENT_DOCUMENT_FROM_CONTENT' | 'EVENT_DOCUMENT_FROM_SEARCH' | 'VISIT_AFFINITY_SCORED' | 'SUGGESTED_APP' | 'SUGGESTED_PERSON' | 'ACTIVITY_HIGHLIGHT' | 'SAVED_SEARCH' | 'SUGGESTED_CHANNEL' | 'PEOPLE_CELEBRATIONS' | 'SOCIAL_LINK' | 'ZERO_STATE_CHAT_SUGGESTION' | 'ZERO_STATE_CHAT_TOOL_SUGGESTION' | 'ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION' | 'ZERO_STATE_STATIC_WORKFLOW_SUGGESTION' | 'ZERO_STATE_AGENT_SUGGESTION' | 'PERSONALIZED_CHAT_SUGGESTION' | 'DAILY_DIGEST' | 'PODCAST' | 'TASK' | 'PLAN_MY_DAY' | 'END_MY_DAY' | 'STARTER_KIT_EXTENSION' | 'STARTER_KIT_ORG_CHART' | 'STARTER_KIT_ADD_DOC' | 'MEETING_RECAP' | 'MEETING_PREP_AUTOMATION' | 'ACTIVE_DISCUSSION' | 'MID_DAY_CATCH_UP' | 'QUERY_SUGGESTION' | 'COWORK_CUJ_PROMO' | 'CARD_STACK_PROMO' | 'WEEKLY_MEETINGS' | 'FOLLOW_UP' | 'MILESTONE_TIMELINE_CHECK' | 'PROJECT_DISCUSSION_DIGEST' | 'PROJECT_FOCUS_BLOCK' | 'PROJECT_NEXT_STEP' | 'DEMO_CARD' | 'OOO_PLANNER' | 'OOO_CATCH_UP' | 'ADMIN_HEALTH_CENTER' — Type of the justification. - `justification` string — Server side generated justification string if server provides one. - `trackingToken` string — An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting. - `viewUrl` string — View URL for the entry if based on links that are not documents in Glean. - `document` 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 - `fullTextList` string[] — The plaintext content of the document. - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - `datasource` string - `datasourceInstance` string — The datasource instance from which the document was extracted. - `objectType` string — The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `container` string — The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId - `containerId` string — The Glean Document ID of the container. Uniquely identifies the container. - `superContainerId` string — The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive. - `parentId` string — The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container - `mimeType` string - `documentId` string — The index-wide unique identifier. - `loggingId` string — A unique identifier used to represent the document in any logging or feedback requests in place of documentId. - `documentIdHash` string — Hash of the Glean Document ID. - `createTime` string, date-time - `updateTime` string, date-time - `author` 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 - … - `owner` 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 - … - `mentionedPeople` Person[] — A list of people mentioned in the document. - `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 - … - `visibility` 'PRIVATE' | 'SPECIFIC_PEOPLE_AND_GROUPS' | 'DOMAIN_LINK' | 'DOMAIN_VISIBLE' | 'PUBLIC_LINK' | 'PUBLIC_VISIBLE' — The level of visibility of the document as understood by our system. - `components` string[] — A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are [components](https://confluence.atlassian.com/jirasoftwarecloud/organizing-work-with-components-764478279.html).) - `status` string — The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix). - `statusCategory` string — The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource. - `pins` PinDocument[] — A list of stars associated with this result. "Pin" is an older name. - `queries` string[] — The query strings for which the pinned result will show. - `audienceFilters` FacetFilter[] — Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search. - … - `id` string — The opaque id of the pin. - `documentId` string, required — The document which should be a pinned result. - `attribution` Person - … - `updatedBy` Person - … - `createTime` string, date-time - `updateTime` string, date-time - `favoriteInfo` FavoriteInfo - … - `priority` string — The document priority. Interpretation is datasource specific. - `assignedTo` 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 - … - `updatedBy` 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 - … - `labels` string[] — A list of tags for the document. Interpretation is datasource specific. - `collections` Collection[] — A list of collections that the document belongs to. - `name` string, required — The unique name of the Collection. - `description` string, required — A brief summary of the Collection's contents. - `addedRoles` UserRoleSpecification[] — A list of added user roles for the Collection. - … - `removedRoles` UserRoleSpecification[] — A list of removed user roles for the Collection. - … - `audienceFilters` FacetFilter[] — Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - … - `icon` string — The emoji icon of this Collection. - `adminLocked` boolean — Indicates whether edits are allowed for everyone or only admins. - `parentId` integer — The parent of this Collection, or 0 if it's a top-level Collection. - `thumbnail` Thumbnail - … - `allowedDatasource` string — The datasource type this Collection can hold. - `permissions` ObjectPermissions - … - `trackingToken` string — An opaque token that represents this particular UGC. To be used for `/feedback` reporting. - `id` integer, required — The unique ID of the Collection. - `createTime` string, date-time - `updateTime` string, date-time - `creator` Person - … - `updatedBy` Person - … - `itemCount` integer — The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - `childCount` integer — The number of children Collections. Separated from the actual children so we can grab the count without children. - `items` CollectionItem[] — The items in this Collection. - … - `pinMetadata` CollectionPinnedMetadata - … - `shortcuts` string[] — The names of the shortcuts (Go Links) that point to this Collection. - `children` Collection[] — The children Collections of this Collection. - `roles` UserRoleSpecification[] — A list of user roles for the Collection. - … - `favoriteInfo` FavoriteInfo - … - `datasourceId` string — The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number). - `interactions` DocumentInteractions - `numComments` integer — The count of comments (thread replies in the case of slack). - `numReactions` integer — The count of reactions on the document. - `reactions` string[] — To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document. - `reacts` Reaction[] - … - `shares` Share[] — Describes instances of someone posting a link to this document in one of our indexed datasources. - … - `visitorCount` CountInfo - … - `verification` Verification - `state` 'UNVERIFIED' | 'VERIFIED' | 'DEPRECATED', required — The verification state for the document. - `metadata` VerificationMetadata - … - `viewerInfo` ViewerInfo - `role` 'ANSWER_MODERATOR' | 'OWNER' | 'VIEWER' — DEPRECATED - use permissions instead. Viewer's role on the specific document. - `lastViewedTime` string, date-time - `permissions` ObjectPermissions - `write` WritePermission — Describes the write permissions levels that a user has for a specific feature - … - `visitCount` CountInfo - `count` integer, required — The counter value - `period` Period - … - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `shortcuts` Shortcut[] — A list of shortcuts of which destination URL is for the document. - `id` integer — The opaque id of the user generated content. - `inputAlias` string, required — Link text following go/ prefix as entered by the user. - `destinationUrl` string — Destination URL for the shortcut. - `destinationDocumentId` string — Glean Document ID for the URL, if known. - `description` string — A short, plain text blurb to help people understand the intent of the shortcut. - `unlisted` boolean — Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - `urlTemplate` string — For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - `addedRoles` UserRoleSpecification[] — A list of user roles added for the Shortcut. - … - `removedRoles` UserRoleSpecification[] — A list of user roles removed for the Shortcut. - … - `permissions` ObjectPermissions - … - `createdBy` Person - … - `createTime` string, date-time — The time the shortcut was created in ISO format (ISO 8601). - `updatedBy` Person - … - `updateTime` string, date-time — The time the shortcut was updated in ISO format (ISO 8601). - `destinationDocument` Document — recursive - `intermediateUrl` string — The URL from which the user is then redirected to the destination URL. Full replacement for https://go/. - `viewPrefix` string — The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - `isExternal` boolean — Indicates whether a shortcut is native or external. - `editUrl` string — The URL using which the user can access the edit page of the shortcut. - `alias` string — canonical link text following go/ prefix where hyphen/underscore is removed. - `title` string — Title for the Go Link - `roles` UserRoleSpecification[] — A list of user roles for the Go Link. - … - `favoriteInfo` FavoriteInfo - … - `path` string — For file datasources like onedrive/github etc this has the path to the file - `customData` CustomData — Custom fields specific to individual datasources - `documentCategory` string — The document's document_category(.proto). - `contactPerson` 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 - … - `thumbnail` Thumbnail - `photoId` string — Photo id if the thumbnail is from splash. - `url` string — Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - `indexStatus` IndexStatus - `lastCrawledTime` string, date-time — When the document was last crawled - `lastIndexedTime` string, date-time — When the document was last indexed - `ancestors` Document[] — A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list. - `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. - `title` string — The title of the document section (e.g. the section header). - `url` string — The permalink of the document section. - `event` CalendarEvent — A generic, light-weight calendar event. - `time` TimeInterval - `start` string, required — The RFC3339 timestamp formatted start time of this event. - `end` string, required — The RFC3339 timestamp formatted end time of this event. - `eventType` 'DEFAULT' | 'OUT_OF_OFFICE' — The nature of the event, for example "out of office". - `id` string, required — The calendar event id - `url` string, required — A permalink for this calendar event - `attendees` CalendarAttendees - `people` CalendarAttendee[] — Full details of some of the attendees of this event - `isOrganizer` boolean — Whether or not this attendee is an organizer. - `isInGroup` boolean — Whether or not this attendee is in a group. Needed temporarily at least to support both flat attendees and tree for compatibility. - `person` Person, required - … - `groupAttendees` CalendarAttendee[] — If this attendee is a group, represents the list of individual attendees in the group. - `responseStatus` 'ACCEPTED' | 'DECLINED' | 'NO_RESPONSE' | 'TENTATIVE' - `isLimit` boolean — Whether the total count of the people returned is at the retrieval limit. - `total` integer — Total number of attendees in this event. - `numAccepted` integer — Total number of attendees who have accepted this event. - `numDeclined` integer — Total number of attendees who have declined this event. - `numNoResponse` integer — Total number of attendees who have not responded to this event. - `numTentative` integer — Total number of attendees who have responded tentatively (i.e. responded maybe) to this event. - `location` string — The location that this event is taking place at. - `conferenceData` ConferenceData - `provider` 'ZOOM' | 'HANGOUTS', required - `uri` string, required — A permalink for the conference. - `source` 'NATIVE_CONFERENCE' | 'LOCATION' | 'DESCRIPTION' - `description` string — The HTML description of the event. - `datasource` string — The app or other repository type from which the event was extracted - `hasTranscript` boolean — The event has a transcript associated with it enabling features like summarization - `transcriptUrl` string — A link to the transcript of the event - `classifications` EventClassification[] - `name` 'External Event' — The name for a generated classification of an event. - `strategies` EventStrategyName[] - `generatedAttachments` GeneratedAttachment[] - `strategyName` 'customerCard' | 'news' | 'call' | 'email' | 'meetingNotes' | 'linkedIn' | 'relevantDocuments' | 'chatFollowUps' | 'conversations' — The name of method used to surface relevant data for a given calendar event. - `documents` 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. - … - `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. - … - `metadata` PersonMetadata - … - `customer` Customer - `id` string, required — Unique identifier. - `domains` string[] — Link to company's associated website domains. - `company` Company, required - … - `documentCounts` DocumentCounts — A map of {string, int} pairs representing counts of each document type associated with this customer. - `poc` Person[] — A list of POC for company. - … - `metadata` CustomerMetadata - … - `mergedCustomers` Customer[] — A list of Customers. - `startDate` string, date — The date when the interaction with customer started. - `contractAnnualRevenue` number, double — Average contract annual revenue with that customer. - `notes` string — User facing (potentially generated) notes about company. - `externalLinks` StructuredLink[] — A list of links to external sources outside of Glean. - `name` string — The display name for the link - `url` string — The URL for the link. - `iconConfig` IconConfig — Defines how to render an icon - … - `content` GeneratedAttachmentContent[] - `displayHeader` string — The header describing the generated content. - `text` string — The content that has been generated. - `announcement` Announcement - `startTime` string, date-time — The date and time at which the announcement becomes active. - `endTime` string, date-time — The date and time at which the announcement expires. - `title` string — The headline of the announcement. - `body` StructuredText - `text` string, required - `structuredList` StructuredTextItem[] — An array of objects each of which contains either a string or a link which optionally corresponds to a document. - `link` string - `document` Document - … - `text` string - `structuredResult` StructuredResult — A single object that can support any object in the work graph. Only a single object will be populated. - … - `emoji` string — An emoji used to indicate the nature of the announcement. - `thumbnail` Thumbnail - `photoId` string — Photo id if the thumbnail is from splash. - `url` string — Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - `banner` Thumbnail - `photoId` string — Photo id if the thumbnail is from splash. - `url` string — Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - `audienceFilters` FacetFilter[] — Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search. - `fieldName` string - `values` FacetFilterValue[] — Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - `value` string - `relationType` 'EQUALS' | 'ID_EQUALS' | 'LT' | 'GT' | 'NOT_EQUALS' - `isNegated` boolean — DEPRECATED - please use relationType instead - `groupName` string — Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - `sourceDocumentId` string — The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). - `hideAttribution` boolean — Whether or not to hide an author attribution. - `channel` 'MAIN' | 'SOCIAL_FEED' — This determines whether this is a Social Feed post or a regular announcement. - `postType` 'TEXT' | 'LINK' — This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. - `isPrioritized` boolean — Used by the Social Feed to pin posts to the front of the feed. - `viewUrl` string — URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". - `draftId` integer — The opaque id of the associated draft. - `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 - `trackingToken` string — An opaque token that represents this particular UGC. To be used for `/feedback` reporting. - `id` integer — The opaque id of the announcement. - `author` 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. - `createTimestamp` integer — Server Unix timestamp of the creation time (in seconds since epoch UTC). - `lastUpdateTimestamp` integer — Server Unix timestamp of the last update time (in seconds since epoch UTC). - `updatedBy` 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. - `viewerInfo` object - `isDismissed` boolean — Whether the viewer has dismissed the announcement. - `isRead` boolean — Whether the viewer has read the announcement. - `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 - `fullTextList` string[] — The plaintext content of the document. - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - `datasource` string - `datasourceInstance` string — The datasource instance from which the document was extracted. - `objectType` string — The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `container` string — The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId - `containerId` string — The Glean Document ID of the container. Uniquely identifies the container. - `superContainerId` string — The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive. - `parentId` string — The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container - `mimeType` string - `documentId` string — The index-wide unique identifier. - `loggingId` string — A unique identifier used to represent the document in any logging or feedback requests in place of documentId. - `documentIdHash` string — Hash of the Glean Document ID. - `createTime` string, date-time - `updateTime` string, date-time - `author` Person - … - `owner` Person - … - `mentionedPeople` Person[] — A list of people mentioned in the document. - … - `visibility` 'PRIVATE' | 'SPECIFIC_PEOPLE_AND_GROUPS' | 'DOMAIN_LINK' | 'DOMAIN_VISIBLE' | 'PUBLIC_LINK' | 'PUBLIC_VISIBLE' — The level of visibility of the document as understood by our system. - `components` string[] — A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are [components](https://confluence.atlassian.com/jirasoftwarecloud/organizing-work-with-components-764478279.html).) - `status` string — The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix). - `statusCategory` string — The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource. - `pins` PinDocument[] — A list of stars associated with this result. "Pin" is an older name. - … - `priority` string — The document priority. Interpretation is datasource specific. - `assignedTo` Person - … - `updatedBy` Person - … - `labels` string[] — A list of tags for the document. Interpretation is datasource specific. - `collections` Collection[] — A list of collections that the document belongs to. - … - `datasourceId` string — The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number). - `interactions` DocumentInteractions - … - `verification` Verification - … - `viewerInfo` ViewerInfo - … - `permissions` ObjectPermissions - … - `visitCount` CountInfo - … - `shortcuts` Shortcut[] — A list of shortcuts of which destination URL is for the document. - … - `path` string — For file datasources like onedrive/github etc this has the path to the file - `customData` CustomData — Custom fields specific to individual datasources - `documentCategory` string — The document's document_category(.proto). - `contactPerson` Person - … - `thumbnail` Thumbnail - … - `indexStatus` IndexStatus - … - `ancestors` Document[] — A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list. - `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. - `title` string — The title of the document section (e.g. the section header). - `url` string — The permalink of the document section. - `isPublished` boolean — Whether or not the announcement is published. - `favoriteInfo` FavoriteInfo - `ugcType` 'AGENT_TYPE' | 'ANNOUNCEMENTS_TYPE' | 'ANSWERS_TYPE' | 'CHATS_TYPE' | 'COLLECTIONS_TYPE' | 'EMAIL_TYPE' | 'HTML_CODE_TYPE' | 'IMAGE_TYPE' | 'MESSAGE_TYPE' | 'PAPER_TYPE' | 'PRISM_VIEWS_TYPE' | 'PROMPT_TEMPLATES_TYPE' | 'PINS_TYPE' | 'SCRIBES_TYPE' | 'SHORTCUTS_TYPE' | 'SLIDE_TYPE' | 'SPREADSHEET_TYPE' | 'INLINE_HTML_TYPE' | 'PODCAST_TYPE' | 'WORKFLOWS_TYPE' - `id` string — Opaque id of the UGC. - `count` integer — Number of users this object has been favorited by. - `favoritedByUser` boolean — If the requesting user has favorited this object. - `digest` Digest - `podcastFileId` string — Identifier for the podcast file generated from this digest content. - `podcastDuration` number, float — Duration of the podcast file in seconds. - `digestDate` string — The date this digest covers, in YYYY-MM-DD format. Represents the specific day for which the digest content and updates were compiled. This can be empty if the digest is not yet available. - `sections` DigestSection[] — Array of digest sections from which the podcast was created. - `id` string, required — Unique identifier for the digest section. - `type` 'CHANNEL' | 'MENTIONS' | 'TOPIC', required — Type of the section. This defines how the section should be interpreted and rendered in the digest. - `displayName` string — Human-readable name for the digest section. - `channelName` string — Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend. - `channelType` string — Channel visibility/type for CHANNEL sections. For Slack this is typically one of PublicChannel, PrivateChannel. Omit if not applicable or unknown. - `instanceId` string — Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend. - `url` string — Optional URL for the digest section. Should be populated only if the section is a CHANNEL type section. - `updates` DigestUpdate[], required — List of updates within this digest section. - `urls` string[] — List of URLs for similar updates that are grouped together and rendered as a single update. - `url` string — URL link to the content or document. - `title` string — Title or headline of the update. - `datasource` string — Name or identifier of the data source (e.g., slack, confluence, etc.). - `summary` string — Brief summary or description of the update content. - `type` 'ACTIONABLE' | 'INFORMATIVE' — Optional type classification for the update. - `collection` Collection - `name` string, required — The unique name of the Collection. - `description` string, required — A brief summary of the Collection's contents. - `addedRoles` UserRoleSpecification[] — A list of added user roles for the Collection. - `sourceDocumentSpec` union - object - … - object - … - object - … - object - … - `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. - … - `metadata` PersonMetadata - … - `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. - `removedRoles` UserRoleSpecification[] — A list of removed user roles for the Collection. - `sourceDocumentSpec` union - object - … - object - … - object - … - object - … - `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. - … - `metadata` PersonMetadata - … - `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. - `audienceFilters` FacetFilter[] — Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - `fieldName` string - `values` FacetFilterValue[] — Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - `value` string - `relationType` 'EQUALS' | 'ID_EQUALS' | 'LT' | 'GT' | 'NOT_EQUALS' - `isNegated` boolean — DEPRECATED - please use relationType instead - `groupName` string — Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - `icon` string — The emoji icon of this Collection. - `adminLocked` boolean — Indicates whether edits are allowed for everyone or only admins. - `parentId` integer — The parent of this Collection, or 0 if it's a top-level Collection. - `thumbnail` Thumbnail - `photoId` string — Photo id if the thumbnail is from splash. - `url` string — Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - `allowedDatasource` string — The datasource type this Collection can hold. - `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 - `trackingToken` string — An opaque token that represents this particular UGC. To be used for `/feedback` reporting. - `id` integer, required — The unique ID of the Collection. - `createTime` string, date-time - `updateTime` string, date-time - `creator` 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. - `updatedBy` 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. - `itemCount` integer — The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - `childCount` integer — The number of children Collections. Separated from the actual children so we can grab the count without children. - `items` CollectionItem[] — The items in this Collection. - `name` string — The optional name of the Collection item. - `description` string — A helpful description of why this CollectionItem is in the Collection that it's in. - `icon` string — The emoji icon for this CollectionItem. Only used for Text type items. - `collectionId` integer, required — The Collection ID of the Collection that this CollectionItem belongs in. - `documentId` string — If this CollectionItem is indexed, the Glean Document ID of that document. - `url` string — The URL of this CollectionItem. - `itemId` string — Unique identifier for the item within the Collection it belongs to. - `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. - … - `metadata` PersonMetadata - … - `createdAt` string, date-time — Unix timestamp for when the item was first added (in seconds since epoch UTC). - `document` 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. - … - `shortcut` Shortcut - `id` integer — The opaque id of the user generated content. - `inputAlias` string, required — Link text following go/ prefix as entered by the user. - `destinationUrl` string — Destination URL for the shortcut. - `destinationDocumentId` string — Glean Document ID for the URL, if known. - `description` string — A short, plain text blurb to help people understand the intent of the shortcut. - `unlisted` boolean — Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - `urlTemplate` string — For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - `addedRoles` UserRoleSpecification[] — A list of user roles added for the Shortcut. - … - `removedRoles` UserRoleSpecification[] — A list of user roles removed for the Shortcut. - … - `permissions` ObjectPermissions - … - `createdBy` Person - … - `createTime` string, date-time — The time the shortcut was created in ISO format (ISO 8601). - `updatedBy` Person - … - `updateTime` string, date-time — The time the shortcut was updated in ISO format (ISO 8601). - `destinationDocument` Document - … - `intermediateUrl` string — The URL from which the user is then redirected to the destination URL. Full replacement for https://go/. - `viewPrefix` string — The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - `isExternal` boolean — Indicates whether a shortcut is native or external. - `editUrl` string — The URL using which the user can access the edit page of the shortcut. - `alias` string — canonical link text following go/ prefix where hyphen/underscore is removed. - `title` string — Title for the Go Link - `roles` UserRoleSpecification[] — A list of user roles for the Go Link. - … - `favoriteInfo` FavoriteInfo - … - `collection` Collection — recursive - `itemType` 'DOCUMENT' | 'TEXT' | 'URL' | 'COLLECTION', required - `pinMetadata` CollectionPinnedMetadata - `existingPins` CollectionPinTarget[] — List of targets this Collection is pinned to. - `category` 'COMPANY_RESOURCE' | 'DEPARTMENT_RESOURCE' | 'TEAM_RESOURCE', required — Categories a Collection can be pinned to. - `value` string — Optional. If category supports values, then the additional value for the category e.g. department name for DEPARTMENT_RESOURCE, team name/id for TEAM_RESOURCE and so on. - `target` 'RESOURCE_CARD' | 'TEAM_PROFILE_PAGE' — What targets can a Collection be pinned to. - `eligiblePins` CollectionPinMetadata[] — List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection. - `id` integer, required — The ID of the Collection. - `target` CollectionPinTarget, required - … - `shortcuts` string[] — The names of the shortcuts (Go Links) that point to this Collection. - `children` Collection[] — The children Collections of this Collection. - `roles` UserRoleSpecification[] — A list of user roles for the Collection. - `sourceDocumentSpec` union - object - … - object - … - object - … - object - … - `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. - … - `metadata` PersonMetadata - … - `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. - `favoriteInfo` FavoriteInfo - `ugcType` 'AGENT_TYPE' | 'ANNOUNCEMENTS_TYPE' | 'ANSWERS_TYPE' | 'CHATS_TYPE' | 'COLLECTIONS_TYPE' | 'EMAIL_TYPE' | 'HTML_CODE_TYPE' | 'IMAGE_TYPE' | 'MESSAGE_TYPE' | 'PAPER_TYPE' | 'PRISM_VIEWS_TYPE' | 'PROMPT_TEMPLATES_TYPE' | 'PINS_TYPE' | 'SCRIBES_TYPE' | 'SHORTCUTS_TYPE' | 'SLIDE_TYPE' | 'SPREADSHEET_TYPE' | 'INLINE_HTML_TYPE' | 'PODCAST_TYPE' | 'WORKFLOWS_TYPE' - `id` string — Opaque id of the UGC. - `count` integer — Number of users this object has been favorited by. - `favoritedByUser` boolean — If the requesting user has favorited this object. - `collectionItem` CollectionItem - `name` string — The optional name of the Collection item. - `description` string — A helpful description of why this CollectionItem is in the Collection that it's in. - `icon` string — The emoji icon for this CollectionItem. Only used for Text type items. - `collectionId` integer, required — The Collection ID of the Collection that this CollectionItem belongs in. - `documentId` string — If this CollectionItem is indexed, the Glean Document ID of that document. - `url` string — The URL of this CollectionItem. - `itemId` string — Unique identifier for the item within the Collection it belongs to. - `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 - … - `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. - `createdAt` string, date-time — Unix timestamp for when the item was first added (in seconds since epoch UTC). - `document` 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 - `fullTextList` string[] — The plaintext content of the document. - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - `datasource` string - `datasourceInstance` string — The datasource instance from which the document was extracted. - `objectType` string — The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `container` string — The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId - `containerId` string — The Glean Document ID of the container. Uniquely identifies the container. - `superContainerId` string — The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive. - `parentId` string — The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container - `mimeType` string - `documentId` string — The index-wide unique identifier. - `loggingId` string — A unique identifier used to represent the document in any logging or feedback requests in place of documentId. - `documentIdHash` string — Hash of the Glean Document ID. - `createTime` string, date-time - `updateTime` string, date-time - `author` Person - … - `owner` Person - … - `mentionedPeople` Person[] — A list of people mentioned in the document. - … - `visibility` 'PRIVATE' | 'SPECIFIC_PEOPLE_AND_GROUPS' | 'DOMAIN_LINK' | 'DOMAIN_VISIBLE' | 'PUBLIC_LINK' | 'PUBLIC_VISIBLE' — The level of visibility of the document as understood by our system. - `components` string[] — A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are [components](https://confluence.atlassian.com/jirasoftwarecloud/organizing-work-with-components-764478279.html).) - `status` string — The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix). - `statusCategory` string — The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource. - `pins` PinDocument[] — A list of stars associated with this result. "Pin" is an older name. - … - `priority` string — The document priority. Interpretation is datasource specific. - `assignedTo` Person - … - `updatedBy` Person - … - `labels` string[] — A list of tags for the document. Interpretation is datasource specific. - `collections` Collection[] — A list of collections that the document belongs to. - … - `datasourceId` string — The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number). - `interactions` DocumentInteractions - … - `verification` Verification - … - `viewerInfo` ViewerInfo - … - `permissions` ObjectPermissions - … - `visitCount` CountInfo - … - `shortcuts` Shortcut[] — A list of shortcuts of which destination URL is for the document. - … - `path` string — For file datasources like onedrive/github etc this has the path to the file - `customData` CustomData — Custom fields specific to individual datasources - `documentCategory` string — The document's document_category(.proto). - `contactPerson` Person - … - `thumbnail` Thumbnail - … - `indexStatus` IndexStatus - … - `ancestors` Document[] — A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list. - `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. - `title` string — The title of the document section (e.g. the section header). - `url` string — The permalink of the document section. - `shortcut` Shortcut - `id` integer — The opaque id of the user generated content. - `inputAlias` string, required — Link text following go/ prefix as entered by the user. - `destinationUrl` string — Destination URL for the shortcut. - `destinationDocumentId` string — Glean Document ID for the URL, if known. - `description` string — A short, plain text blurb to help people understand the intent of the shortcut. - `unlisted` boolean — Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only. - `urlTemplate` string — For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL. - `addedRoles` UserRoleSpecification[] — A list of user roles added for the Shortcut. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `removedRoles` UserRoleSpecification[] — A list of user roles removed for the Shortcut. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `permissions` ObjectPermissions - `write` WritePermission — Describes the write permissions levels that a user has for a specific feature - … - `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. - … - `metadata` PersonMetadata - … - `createTime` string, date-time — The time the shortcut was created in ISO format (ISO 8601). - `updatedBy` 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 - … - `updateTime` string, date-time — The time the shortcut was updated in ISO format (ISO 8601). - `destinationDocument` 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. - … - `intermediateUrl` string — The URL from which the user is then redirected to the destination URL. Full replacement for https://go/. - `viewPrefix` string — The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts. - `isExternal` boolean — Indicates whether a shortcut is native or external. - `editUrl` string — The URL using which the user can access the edit page of the shortcut. - `alias` string — canonical link text following go/ prefix where hyphen/underscore is removed. - `title` string — Title for the Go Link - `roles` UserRoleSpecification[] — A list of user roles for the Go Link. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `favoriteInfo` FavoriteInfo - `ugcType` 'AGENT_TYPE' | 'ANNOUNCEMENTS_TYPE' | 'ANSWERS_TYPE' | 'CHATS_TYPE' | 'COLLECTIONS_TYPE' | 'EMAIL_TYPE' | 'HTML_CODE_TYPE' | 'IMAGE_TYPE' | 'MESSAGE_TYPE' | 'PAPER_TYPE' | 'PRISM_VIEWS_TYPE' | 'PROMPT_TEMPLATES_TYPE' | 'PINS_TYPE' | 'SCRIBES_TYPE' | 'SHORTCUTS_TYPE' | 'SLIDE_TYPE' | 'SPREADSHEET_TYPE' | 'INLINE_HTML_TYPE' | 'PODCAST_TYPE' | 'WORKFLOWS_TYPE' - `id` string — Opaque id of the UGC. - `count` integer — Number of users this object has been favorited by. - `favoritedByUser` boolean — If the requesting user has favorited this object. - `collection` Collection - `name` string, required — The unique name of the Collection. - `description` string, required — A brief summary of the Collection's contents. - `addedRoles` UserRoleSpecification[] — A list of added user roles for the Collection. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `removedRoles` UserRoleSpecification[] — A list of removed user roles for the Collection. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `audienceFilters` FacetFilter[] — Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search. - `fieldName` string - `values` FacetFilterValue[] — Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet. - … - `groupName` string — Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet. - `icon` string — The emoji icon of this Collection. - `adminLocked` boolean — Indicates whether edits are allowed for everyone or only admins. - `parentId` integer — The parent of this Collection, or 0 if it's a top-level Collection. - `thumbnail` Thumbnail - `photoId` string — Photo id if the thumbnail is from splash. - `url` string — Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - `allowedDatasource` string — The datasource type this Collection can hold. - `permissions` ObjectPermissions - `write` WritePermission — Describes the write permissions levels that a user has for a specific feature - … - `trackingToken` string — An opaque token that represents this particular UGC. To be used for `/feedback` reporting. - `id` integer, required — The unique ID of the Collection. - `createTime` string, date-time - `updateTime` string, date-time - `creator` 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 - … - `updatedBy` 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 - … - `itemCount` integer — The number of items currently in the Collection. Separated from the actual items so we can grab the count without items. - `childCount` integer — The number of children Collections. Separated from the actual children so we can grab the count without children. - `items` CollectionItem[] — The items in this Collection. - `pinMetadata` CollectionPinnedMetadata - `existingPins` CollectionPinTarget[] — List of targets this Collection is pinned to. - … - `eligiblePins` CollectionPinMetadata[] — List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection. - … - `shortcuts` string[] — The names of the shortcuts (Go Links) that point to this Collection. - `children` Collection[] — The children Collections of this Collection. - `roles` UserRoleSpecification[] — A list of user roles for the Collection. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `favoriteInfo` FavoriteInfo - `ugcType` 'AGENT_TYPE' | 'ANNOUNCEMENTS_TYPE' | 'ANSWERS_TYPE' | 'CHATS_TYPE' | 'COLLECTIONS_TYPE' | 'EMAIL_TYPE' | 'HTML_CODE_TYPE' | 'IMAGE_TYPE' | 'MESSAGE_TYPE' | 'PAPER_TYPE' | 'PRISM_VIEWS_TYPE' | 'PROMPT_TEMPLATES_TYPE' | 'PINS_TYPE' | 'SCRIBES_TYPE' | 'SHORTCUTS_TYPE' | 'SLIDE_TYPE' | 'SPREADSHEET_TYPE' | 'INLINE_HTML_TYPE' | 'PODCAST_TYPE' | 'WORKFLOWS_TYPE' - `id` string — Opaque id of the UGC. - `count` integer — Number of users this object has been favorited by. - `favoritedByUser` boolean — If the requesting user has favorited this object. - `itemType` 'DOCUMENT' | 'TEXT' | 'URL' | 'COLLECTION', required - `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 - `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. - `app` AppResult - `datasource` string, required — The app or other repository type this represents - `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). - `mimeType` string — Mimetype is used to differentiate between sub applications from a datasource (e.g. Sheets, Docs from Gdrive) - `iconUrl` string — If there is available icon URL. - `chatSuggestion` ChatSuggestion - `query` string — The actionable chat query to run when the user selects this suggestion. - `cta` string — Button text to show for the suggestion action. - `feature` string — Targeted Glean Chat feature for the suggestion. - `sourceDocumentIds` string[] — Document IDs that grounded the suggestion. - `promptTemplate` PromptTemplateResult - `promptTemplate` PromptTemplate - `name` string — The user-given identifier for this prompt template. - `template` string, required — The actual template string. - `applicationId` string — The Application Id the prompt template should be created under. Empty for default assistant. - `inclusions` ChatRestrictionFilters - `containerSpecs` DocumentSpec[] — Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections. - … - `documentSpecs` DocumentSpec[] - … - `datasourceInstances` string[] - `addedRoles` UserRoleSpecification[] — A list of added user roles for the Workflow. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `removedRoles` UserRoleSpecification[] — A list of removed user roles for the Workflow. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `role` 'OWNER' | 'VIEWER' | 'ANSWER_MODERATOR' | 'EDITOR' | 'VERIFIER', required — A user's role with respect to a specific document. - `permissions` ObjectPermissions - `write` WritePermission — Describes the write permissions levels that a user has for a specific feature - … - `id` string — Opaque id for this prompt template - `author` 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 - … - `createTimestamp` integer — Server Unix timestamp of the creation time. - `lastUpdateTimestamp` integer — Server Unix timestamp of the last update time. - `lastUpdatedBy` 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 - … - `roles` UserRoleSpecification[] — A list of roles for this prompt template explicitly granted. - `sourceDocumentSpec` union - … - `person` Person - … - `group` Group - … - `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 prompt template - `favoriteInfo` FavoriteInfo - `ugcType` 'AGENT_TYPE' | 'ANNOUNCEMENTS_TYPE' | 'ANSWERS_TYPE' | 'CHATS_TYPE' | 'COLLECTIONS_TYPE' | 'EMAIL_TYPE' | 'HTML_CODE_TYPE' | 'IMAGE_TYPE' | 'MESSAGE_TYPE' | 'PAPER_TYPE' | 'PRISM_VIEWS_TYPE' | 'PROMPT_TEMPLATES_TYPE' | 'PINS_TYPE' | 'SCRIBES_TYPE' | 'SHORTCUTS_TYPE' | 'SLIDE_TYPE' | 'SPREADSHEET_TYPE' | 'INLINE_HTML_TYPE' | 'PODCAST_TYPE' | 'WORKFLOWS_TYPE' - `id` string — Opaque id of the UGC. - `count` integer — Number of users this object has been favorited by. - `favoritedByUser` boolean — If the requesting user has favorited this object. - `runCount` CountInfo - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - … - `end` TimePoint - … - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `workflow` WorkflowResult - `workflow` Workflow, required - `permissions` ObjectPermissions - `write` WritePermission — Describes the write permissions levels that a user has for a specific feature - … - `name` string — The name of the workflow. - `author` 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 - … - `createTimestamp` integer — Server Unix timestamp of the creation time. - `lastUpdateTimestamp` integer — Server Unix timestamp of the last update time. - `lastDraftSavedAt` integer — Server Unix timestamp of the last time the draft was saved. - `lastDraftSavedBy` 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 - … - `lastDraftGitAuthorId` string — ID of the VCS user (e.g. GitHub username) who last saved the draft. Set only by the draft save path via the external Git integration API. - `lastUpdatedBy` 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 - … - `id` string — The ID of the workflow. - `verified` boolean — When present, indicates this workflow is admin-verified. Set via the dedicated admin settings endpoint, not by regular edits. - `showOrganizationAsAuthor` boolean — When true, displays organization name instead of author name in agent card. Set via the dedicated admin settings endpoint, not by regular edits. - `webhookUrl` string — For a CUSTOM_WEBHOOK-triggered agent, the full inbound webhook URL (.../webhooks/custom/) minted for the agent. Empty for other trigger types. - `activities` UserActivity[] — List of activity where each activity has user, action, timestamp. - `actor` 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. - `timestamp` integer — Unix timestamp of the activity (in seconds since epoch UTC). - `action` 'ADD' | 'ADD_REMINDER' | 'CLICK' | 'COMMENT' | 'DELETE' | 'DISMISS' | 'EDIT' | 'MENTION' | 'MOVE' | 'OTHER' | 'RESTORE' | 'UNKNOWN' | 'VERIFY' | 'VIEW' — The action for the activity - `aggregateVisitCount` CountInfo - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - … - `end` TimePoint - … - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `documentVisitorCount` CountInfo - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `secondaryEntries` FeedEntry[] — Secondary entries for the result e.g. suggested docs for the calendar, carousel. - `entryId` string — optional ID associated with a single feed entry (displayable_list_id) - `title` string, required — Title for the result. Can be document title, event title and so on. - `thumbnail` Thumbnail - `photoId` string — Photo id if the thumbnail is from splash. - `url` string — Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean. - `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. - `uiConfig` object - `format` 'LIST' — defines how to render this particular displayable list card - `additionalFlags` DisplayableListItemUIConfig — UI configurations for each item of the list - `showNewIndicator` boolean — show a "New" pill next to the item - `justificationType` 'FREQUENTLY_ACCESSED' | 'RECENTLY_ACCESSED' | 'TRENDING_DOCUMENT' | 'VERIFICATION_REMINDER' | 'SUGGESTED_DOCUMENT' | 'EMPTY_STATE_SUGGESTION' | 'FRECENCY_SCORED' | 'SERVER_GENERATED' | 'USE_CASE' | 'UPDATE_SINCE_LAST_VIEW' | 'RECENTLY_STARTED' | 'EVENT' | 'USER_MENTION' | 'ANNOUNCEMENT' | 'EXTERNAL_ANNOUNCEMENT' | 'POPULARITY_BASED_TRENDING' | 'COMPANY_RESOURCE' | 'EVENT_DOCUMENT_FROM_CONTENT' | 'EVENT_DOCUMENT_FROM_SEARCH' | 'VISIT_AFFINITY_SCORED' | 'SUGGESTED_APP' | 'SUGGESTED_PERSON' | 'ACTIVITY_HIGHLIGHT' | 'SAVED_SEARCH' | 'SUGGESTED_CHANNEL' | 'PEOPLE_CELEBRATIONS' | 'SOCIAL_LINK' | 'ZERO_STATE_CHAT_SUGGESTION' | 'ZERO_STATE_CHAT_TOOL_SUGGESTION' | 'ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION' | 'ZERO_STATE_STATIC_WORKFLOW_SUGGESTION' | 'ZERO_STATE_AGENT_SUGGESTION' | 'PERSONALIZED_CHAT_SUGGESTION' | 'DAILY_DIGEST' | 'PODCAST' | 'TASK' | 'PLAN_MY_DAY' | 'END_MY_DAY' | 'STARTER_KIT_EXTENSION' | 'STARTER_KIT_ORG_CHART' | 'STARTER_KIT_ADD_DOC' | 'MEETING_RECAP' | 'MEETING_PREP_AUTOMATION' | 'ACTIVE_DISCUSSION' | 'MID_DAY_CATCH_UP' | 'QUERY_SUGGESTION' | 'COWORK_CUJ_PROMO' | 'CARD_STACK_PROMO' | 'WEEKLY_MEETINGS' | 'FOLLOW_UP' | 'MILESTONE_TIMELINE_CHECK' | 'PROJECT_DISCUSSION_DIGEST' | 'PROJECT_FOCUS_BLOCK' | 'PROJECT_NEXT_STEP' | 'DEMO_CARD' | 'OOO_PLANNER' | 'OOO_CATCH_UP' | 'ADMIN_HEALTH_CENTER' — Type of the justification. - `justification` string — Server side generated justification string if server provides one. - `trackingToken` string — An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting. - `viewUrl` string — View URL for the entry if based on links that are not documents in Glean. - `document` 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 - `fullTextList` string[] — The plaintext content of the document. - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - `datasource` string - `datasourceInstance` string — The datasource instance from which the document was extracted. - `objectType` string — The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `container` string — The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId - `containerId` string — The Glean Document ID of the container. Uniquely identifies the container. - `superContainerId` string — The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive. - `parentId` string — The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container - `mimeType` string - `documentId` string — The index-wide unique identifier. - `loggingId` string — A unique identifier used to represent the document in any logging or feedback requests in place of documentId. - `documentIdHash` string — Hash of the Glean Document ID. - `createTime` string, date-time - `updateTime` string, date-time - `author` Person - `name` string, required — The display name. - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — Invalid request - `401` — Not Authorized - `408` — Request Timeout - `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)