--- title: "Read pin" method: POST path: "/rest/api/v1/getpin" tags: ["Pins"] --- # Read pin `POST /rest/api/v1/getpin` Read pin details given its ID. ## Query parameters - `locale` string ## Headers - `X-Glean-ActAs` string, email - `X-Glean-Auth-Type` string ## Request body - GetPinRequest - `id` string — The opaque id of the pin to be fetched. ## Response `200` OK - GetPinResponse - `pin` PinDocument - `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. - `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. - `id` string — The opaque id of the pin. - `documentId` string, required — The document which should be a pinned result. - `attribution` 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 - `name` string — Name of the search provider. - `logoUrl` string — URL to the provider's logo. - `searchLinkUrlTemplate` string — URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion. - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - `id` string — The unique ID of the tab. Can be passed in a search request to get results for that tab. - `count` integer — The number of results in this tab for the current query. - `datasource` string — The datasource associated with the tab, if any. - `datasourceInstance` string — The datasource instance associated with the tab, if any. - `requestOptions` SearchRequestOptions - `datasourceFilter` string — Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - `datasourcesFilter` string[] — Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - `queryOverridesFacetFilters` boolean — If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery. - `facetFilters` FacetFilter[] — A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - … - `facetFilterSets` FacetFilterSet[] — A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - … - `facetBucketFilter` FacetBucketFilter - … - `facetBucketSize` integer, required — The maximum number of FacetBuckets to return in each FacetResult. - `defaultFacets` string[] — Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource. - `authTokens` AuthToken[] — Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - … - `fetchAllDatasourceCounts` boolean — Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter - `responseHints` string[] — Array of hints containing which fields should be populated in the response. - `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. - `disableSpellcheck` boolean — Whether or not to disable spellcheck. - `disableQueryAutocorrect` boolean — Disables automatic adjustment of the input query for spelling corrections or other reasons. - `returnLlmContentOverSnippets` boolean — Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content. - `inclusions` RestrictionFilters - … - `exclusions` RestrictionFilters - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - `startIndex` integer, required — The inclusive start index of the range. - `endIndex` integer — The exclusive end index of the range. - `type` 'BOLD' | 'CITATION' | 'HIGHLIGHT' | 'LINK' - `url` string — The URL associated with the range, if applicable. For example, the linked URL for a LINK range. - `document` Document - … - `inputDetails` SearchRequestInputDetails - `hasCopyPaste` boolean — Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests. - `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 - `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 — recursive - `owner` Person — recursive - `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 — recursive - `updatedBy` Person — recursive - `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 — recursive - `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. - `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. - `document` Document - … - `person` Person — recursive - `customer` Customer - … - `team` Team - … - `customEntity` CustomEntity - … - `answer` Answer - … - `generatedQna` GeneratedQna - … - `extractedQnA` ExtractedQnA - … - `meeting` Meeting - … - `app` AppResult - … - `collection` Collection - … - `code` Code - … - `shortcut` Shortcut - … - `querySuggestions` QuerySuggestionList - … - `chat` ChatMetadata — Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content. - … - `relatedDocuments` RelatedDocuments[] — A list of documents related to this structured result. - `relatedQuestion` RelatedQuestion - … - `disambiguation` Disambiguation — A disambiguation between multiple entities with the same name - … - `snippets` SearchResultSnippet[] — Any snippets associated to the populated object. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `source` 'EXPERT_DETECTION' | 'ENTITY_NLQ' | 'CALENDAR_EVENT' | 'AGENT' — Source context for this result. Possible values depend on the result type. - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `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. - … - `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. - `mimeType` string — The mime type of the snippets, currently either text/plain or text/html. - `text` string — A matching snippet from the document with no highlights. - `snippetTextOrdering` integer — Used for sorting based off the snippet's location within all_snippetable_text - `ranges` TextRange[] — The bolded ranges within text. - … - `url` string — A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text. - `snippet` string — A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead. - `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. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `visibleCountHint` integer, required — The default number of results to display before truncating and showing a "see more" link - `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 - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `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 - … - `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[] - `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 - … - `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 - `channel` 'COMMUNICATION_CHANNEL_EMAIL' | 'COMMUNICATION_CHANNEL_SLACK' - `isAutoInvite` boolean — Bit that tracks if this invite was automatically sent or user-sent - `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. - `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 - union - … - `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 - `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". - `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 - `generatedBackgroundColorKey` string - `backgroundColor` string - `color` string - `key` string - `iconType` 'COLLECTION' | 'CUSTOM' | 'DATASOURCE' | 'DATASOURCE_INSTANCE' | 'FAVICON' | 'FILE_TYPE' | 'GENERATED_BACKGROUND' | 'GLYPH' | 'MIME_TYPE' | 'NO_ICON' | 'PERSON' | 'REACTIONS' | 'URL' - `masked` boolean — Whether the icon should be masked based on current theme. - `name` string — The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - `url` string — The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - `pinned` boolean — The badge should be shown on the PersonAttribution - `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 - `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 - `name` string — Name of the search provider. - `logoUrl` string — URL to the provider's logo. - `searchLinkUrlTemplate` string — URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion. - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - `id` string — The unique ID of the tab. Can be passed in a search request to get results for that tab. - `count` integer — The number of results in this tab for the current query. - `datasource` string — The datasource associated with the tab, if any. - `datasourceInstance` string — The datasource instance associated with the tab, if any. - `requestOptions` SearchRequestOptions - `datasourceFilter` string — Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing. - `datasourcesFilter` string[] — Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing. - `queryOverridesFacetFilters` boolean — If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery. - `facetFilters` FacetFilter[] — A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets. - … - `facetFilterSets` FacetFilterSet[] — A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields. - … - `facetBucketFilter` FacetBucketFilter - … - `facetBucketSize` integer, required — The maximum number of FacetBuckets to return in each FacetResult. - `defaultFacets` string[] — Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource. - `authTokens` AuthToken[] — Auth tokens which may be used for non-indexed, federated results (e.g. Gmail). - … - `fetchAllDatasourceCounts` boolean — Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter - `responseHints` string[] — Array of hints containing which fields should be populated in the response. - `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. - `disableSpellcheck` boolean — Whether or not to disable spellcheck. - `disableQueryAutocorrect` boolean — Disables automatic adjustment of the input query for spelling corrections or other reasons. - `returnLlmContentOverSnippets` boolean — Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content. - `inclusions` RestrictionFilters - … - `exclusions` RestrictionFilters - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - `startIndex` integer, required — The inclusive start index of the range. - `endIndex` integer — The exclusive end index of the range. - `type` 'BOLD' | 'CITATION' | 'HIGHLIGHT' | 'LINK' - `url` string — The URL associated with the range, if applicable. For example, the linked URL for a LINK range. - `document` Document - … - `inputDetails` SearchRequestInputDetails - `hasCopyPaste` boolean — Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests. - `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 - `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 — recursive - `owner` Person — recursive - `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 — recursive - `updatedBy` Person — recursive - `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 — recursive - `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. - `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. - `document` Document - … - `person` Person — recursive - `customer` Customer - … - `team` Team - … - `customEntity` CustomEntity - … - `answer` Answer - … - `generatedQna` GeneratedQna - … - `extractedQnA` ExtractedQnA - … - `meeting` Meeting - … - `app` AppResult - … - `collection` Collection - … - `code` Code - … - `shortcut` Shortcut - … - `querySuggestions` QuerySuggestionList - … - `chat` ChatMetadata — Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content. - … - `relatedDocuments` RelatedDocuments[] — A list of documents related to this structured result. - `relatedQuestion` RelatedQuestion - … - `disambiguation` Disambiguation — A disambiguation between multiple entities with the same name - … - `snippets` SearchResultSnippet[] — Any snippets associated to the populated object. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `source` 'EXPERT_DETECTION' | 'ENTITY_NLQ' | 'CALENDAR_EVENT' | 'AGENT' — Source context for this result. Possible values depend on the result type. - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `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. - … - `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. - `mimeType` string — The mime type of the snippets, currently either text/plain or text/html. - `text` string — A matching snippet from the document with no highlights. - `snippetTextOrdering` integer — Used for sorting based off the snippet's location within all_snippetable_text - `ranges` TextRange[] — The bolded ranges within text. - … - `url` string — A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text. - `snippet` string — A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead. - `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. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `visibleCountHint` integer, required — The default number of results to display before truncating and showing a "see more" link - `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 - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `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 - … - `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[] - `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 - … - `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 - `channel` 'COMMUNICATION_CHANNEL_EMAIL' | 'COMMUNICATION_CHANNEL_SLACK' - `isAutoInvite` boolean — Bit that tracks if this invite was automatically sent or user-sent - `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. - `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 - union - … - `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 - `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". - `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 - `generatedBackgroundColorKey` string - `backgroundColor` string - `color` string - `key` string - `iconType` 'COLLECTION' | 'CUSTOM' | 'DATASOURCE' | 'DATASOURCE_INSTANCE' | 'FAVICON' | 'FILE_TYPE' | 'GENERATED_BACKGROUND' | 'GLYPH' | 'MIME_TYPE' | 'NO_ICON' | 'PERSON' | 'REACTIONS' | 'URL' - `masked` boolean — Whether the icon should be masked based on current theme. - `name` string — The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - `url` string — The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - `pinned` boolean — The badge should be shown on the PersonAttribution - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `createTime` string, date-time - `updateTime` string, date-time - `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. ## Other responses - `400` — Invalid request - `401` — Not Authorized - `429` — Too Many Requests --- [API](https://skmtc.net/gleanwork/apis/glean-client-api.md) · [All operations](https://skmtc.net/gleanwork/apis/glean-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gleanwork/glean-client-api/versions/98678e54a6c5/schema)