# Get All Portals ## Overview The Get All Portals API returns all portals in a partition or department. Endpoint: GET /portals Security: oAuthUser, oAuthOnBehalfOfUser, oAuthCustomer, oAuthOnBehalfOfCustomer, oAuthAnonymousCustomer ## Header parameters: - `x-egain-activity-id` (string) A unique numeric interaction identifier from eGain. Example: "59237" - `x-ext-integration-id` (string) The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id. - `x-ext-interaction-id` (string) A unique interaction identifier from other CRM applications.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id. - `Accept-Language` (string, required) The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses). Enum: "en-US", "es-ES", "fr-FR", "it-IT", "de-DE", "nl-NL", "pt-BR", "pt-PT", "da-DK", "ru-RU", "fr-CA", "zh-CN", "ja-JP", "ko-KR", "sv-SE" ## Query parameters: - `departmentID` (string) The ID of the department. Example: "999" - `$lang` (string) The language that describes the details of a resource. Resources available in different languages may differ from each other.If lang is not passed, then the portal's default language is used. Enum: "en-US", "fr-FR", "en-GB", "es-ES", "it-IT", "nl-NL", "da-DA", "sv-SE", "pt-PT", "fi-FI", "no-NB", "no-NN", "ja-JA", "de-DE", "pt-BR", "zh-CN", "zh-TW", "ko-KO", "ru-RU", "el-EL", "tr-TR", "pl-PL", "cs-CS", "sk-SK", "hu-HU", "sr-SR", "ar-SA", "hr-HR", "ro-RO", "th-TH", "de-AT", "vi-VN", "id-ID", "ms-MY", "fil-PH", "fr-CA", "hi-IN", "uk-UA", "bg-BG", "sl-SI", "xx-XX" - `$pagenum` (integer) Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize. - `$pagesize` (integer) Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum. ## Response 200 fields (application/json): - `portal` (array) portals - `portal.id` (string, required) The alphanumeric ID of the portal.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. - `portal.name` (string, required) The name of the portal. - `portal.departmentId` (string) The ID of the department. Example: "1000001035" - `portal.description` (string) The description of the portal. - `portal.defaultContentLanguageId` (string) The default ID of the language for the portal content. Example: "1" - `portal.defaultContentLanguageCode` (string) The IETF code of the default language for the portal content. - `portal.createdBy` (object) - `portal.createdBy.id` (string) The ID of the user that created this resource. - `portal.createdBy.userName` (string) The resource creator's username. - `portal.createdBy.firstName` (string) The resource creator's first name. - `portal.createdBy.middleName` (string) The resource creator's middle name. - `portal.createdBy.lastName` (string) The resource creator's last name. - `portal.createdDate` (string) The date that the portal was created. - `portal.modifiedBy` (object) - `portal.modifiedBy.id` (string) The ID of the user that modified this resource. - `portal.modifiedBy.userName` (string) The resource modifier's username. - `portal.modifiedBy.firstName` (string) The resource modifier's first name. - `portal.modifiedBy.middleName` (string) The resource modifier's middle name. - `portal.modifiedBy.lastName` (string) The resource modifier's last name. - `portal.modifiedDate` (string) The date on which the portal was last modified. - `portal.isStructuredAuthoringEnabled` (boolean) Indicates if Structured Authoring is enabled for the portal. - `portal.enableDraftSearchInPortal` (boolean) Indicates if Enable Portal Search for Draft and Staging Articles is enabled for the portal. - `portal.portalSettings` (object) The settings for this portal. - `portal.portalSettings.isAnnoucementsEnabled` (boolean) Whether the announcements section is enabled on this portal. - `portal.portalSettings.isArticleFeedbackEnabled` (boolean) Whether article feedback is allowed. - `portal.portalSettings.isArticleFeedbackCommentsEnabled` (boolean) Whether comments should be included in the feedback. - `portal.portalSettings.isArticleFeedbackSummaryEnabled` (boolean) Whether a summary of feedback ratings should be displayed. - `portal.portalSettings.isRelatedArticlesInSameTopicEnabled` (boolean) Whether all articles in the same topic are automatically treated as related articles. - `portal.portalSettings.isRelatedArticlesEnabled` (boolean) Whether the related articles section is shown. - `portal.portalSettings.isAuthenticationRequired` (boolean) Whether the portal requires authentication for access. - `portal.portalSettings.isAgentsSSOEnabled` (boolean) Whether SSO is enabled for agents - `portal.portalSettings.isAgentsDelegatedAuthenticationEnabled` (boolean) Whether delegated authentication is enabled for agents - `portal.portalSettings.customerProfileAttributes` (object) - `portal.portalSettings.customerProfileAttributes.attribute` (array) - `portal.portalSettings.customerProfileAttributes.attribute.name` (string, required) The name of the attribute. - `portal.portalSettings.customerProfileAttributes.attribute.mandatory` (boolean, required) Indicates if the attribute is mandatory. - `portal.portalSettings.customerProfileAttributes.attribute.editable` (boolean, required) Indicates if the attribute is editable. - `portal.portalSettings.isPopularArticlesListEnabled` (boolean) Whether the popular articles list is displayed. Maximum of 50 popular articles will be dislpayed. - `portal.portalSettings.popularArticlesListInfluenceWeight` (number) The weight assigned to the influence of related articles on the ranking of popular articles in the ranking formula. - `portal.portalSettings.popularArticlesListInfluencePeriod` (integer) The timeframe in days that related articles affect the ranking of popular articles in the ranking formula. - `portal.portalSettings.appendSessionJourneyToEmail` (boolean) Whether the session transcript should be appended to the email message. - `portal.portalSettings.isArticleSuggestionsBeforeEscalationEnabled` (boolean) Whether a user is shown suggested articles before escalating. - `portal.portalSettings.isEscalationToEmailEnabled` (boolean) Whether the user can ask a question via email if Guided Help doesn’t provide an answer, triggering a search before escalation. - `portal.portalSettings.numberOfSuggestedArticlesBeforeEscalation` (integer) The number of articles to show to a customer before escalation. - `portal.portalSettings.isGHEnabled` (boolean) Whether guided help is enabled. - `portal.portalSettings.isGHInSearchResultsEnabled` (boolean) Whether to show guided help results in search results. - `portal.portalSettings.isGHStartupQuestionsBeforeUnansweredQuestionsEnabled` (boolean) Whether startup questions should be presented before unanswered questions in Guided Help. - `portal.portalSettings.isGHDetailsForSearchEnabled` (boolean) Whether additional information should be shown in search results. - `portal.portalSettings.isGHShortNameInSearchEnabled` (boolean) When enabled it shows the short names in results. - `portal.portalSettings.isGHClusterScopeDiagnosticsEnabled` (boolean) Whether to show Cluster scope diagnostics during execution. - `portal.portalSettings.isGHResultsShownOnSuccessfulSearch` (boolean) Whether to automatically display results on search success. - `portal.portalSettings.isGHControlActionDiagnosticsEnabled` (boolean) isGHControlActionDiagnosticsEnabled - `portal.portalSettings.GHFailureSuccessThreshold` (number) A value from range that indicates the failure-success score - `portal.portalSettings.maxGHAnsweredQuestions` (integer) A value indicating the maximum number of answered questions. - `portal.portalSettings.maxGHUnansweredQuestions` (integer) A value indicating the maximum number of unanswered questions. - `portal.portalSettings.maxGHSearchResults` (integer) Maximum number of guided help results to return. - `portal.portalSettings.isSearchAutocompleteEnabled` (boolean) Whether the autocomplete interface should be enabled. - `portal.portalSettings.isWebSearchEnabled` (boolean) Whether web searches should be performed as part of multi-search. - `portal.portalSettings.maxWebSearchResults` (integer) The maximum number of results from the web search to return. - `portal.portalSettings.webSearchDomain` (string) Use this to restrict web search results to a specific domain. - `portal.portalSettings.isIntranetSearchEnabled` (boolean) Whether intranet results should be returned as part of multi-search. - `portal.portalSettings.maxIntranetSearchResults` (integer) The maximum number of results from an intranet search to return. - `portal.portalSettings.intranetSearchURL` (string) The URL for the Intranet Search. - `portal.portalSettings.isSpellcheckEnabled` (boolean) Whether spell-correction should be performed on search queries. The corrected query is returned with the results, but is not automatically used. - `portal.portalSettings.questionMatchingEngineURL` (string) The URL for the question matching engine. - `portal.portalSettings.isCustomAttributesFilteringEnabled` (boolean) Whether search results should be filtered by custom attribute values. - `portal.portalSettings.customAttributesForSearchFilter` (array) - `portal.portalSettings.customAttributesForSearchFilter.internalName` (string) The internal name of a custom attribute. - `portal.portalSettings.customAttributesForSearchFilter.externalName` (string) The external or public name of a custom attribute. - `portal.portalSettings.customAttributesForSearchFilter.valueType` (string) The data type of the value of the attribute. Enum: "String", "Integer", "Decimal", "Date", "Boolean" - `portal.portalSettings.customAttributesForSearchFilter.isEnumerated` (boolean) Whether the valueType is enumerated. - `portal.portalSettings.customAttributesForSearchFilter.isMultiselect` (boolean) Whether the user can select multiple values. - `portal.portalSettings.customAttributesForSearchFilter.value` (object) An attribute can have an external value such as a readable label, and an internal value such as a unique ID. This schema provides both the internal and external values for one attribute. - `portal.portalSettings.customAttributesForSearchFilter.value.internalValue` (string) The internal value of the attribute. - `portal.portalSettings.customAttributesForSearchFilter.value.externalValue` (string) The external or public value of the attribute. - `portal.portalSettings.searchLearningInclusionThreshold` (integer) The minimum number of accepts and rejects of an article before article ranking is affected. - `portal.portalSettings.searchLearningInfluence` (integer) A ranking multiplier for learned scoring. - `portal.portalSettings.searchLearningLevel` (integer) Affects the influence of learning on search rankings. 0 = off, 1 = low, 2 = medium, 3 = high, 4 = custom. Enum: 0, 1, 2, 3, 4 - `portal.portalSettings.searchLearningMaxInfluence` (integer) The maximum influence allowed for learned scoring. - `portal.portalSettings.searchRelatedTermWeight` (number) The weight assigned to related terms during search. - `portal.portalSettings.searchRelatedTermsMinResultsThreshold` (integer) If the number of search results is less than or equal to this value, a search with related terms will be used to fill in results. - `portal.portalSettings.isArticleSuggestionsEnabled` (boolean) Whether users can make suggestions on an article. - `portal.portalSettings.isMySuggestionsEnabled` (boolean) Whether a user can view their suggestions. - `portal.portalSettings.isCaptchaEnabled` (boolean) Whether CAPTCHA is enabled or not in the portal. - `portal.portalSettings.captchaSiteKey` (string) The configured CAPTCHA site key. - `portal.portalSettings.isArticleSharingEnabled` (boolean) Whether the article sharing is enabled. - `portal.portalSettings.tagCategoriesForSearchFilter` (object) - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory` (array) - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory.name` (string) Name of the Tag Category - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory.id` (string) The ID of the Tag Category.A Tag Category ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory.tag` (array) - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory.tag.name` (string) Name of the Tag - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory.tag.id` (string) The ID of the Tag .A Tag ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory.tagGroup` (array) - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory.tagGroup.name` (string) Name of the Tag Group - `portal.portalSettings.tagCategoriesForSearchFilter.tagCategory.tagGroup.id` (string) The ID of the Tag Group.A Tag Group ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. - `portal.kbLanguages` (object) KB languages - `portal.kbLanguages.KbLanguage` (array) - `portal.kbLanguages.KbLanguage.name` (string) Name of the language. Enum: "English (United States)", "English (United Kingdom)", "French (France)", "Spanish (Spain)", "Italian (Italy)", "German (Germany)", "Dutch (Netherlands)", "Portuguese (Brazil)", "Portuguese (Portugal)", "Danish (Denmark)", "Swedish (Sweden)", "Russian (Russia)", "French (Canada)", "Chinese (Simplified)", "Japanese (Japan)", "Korean (South Korea)" - `portal.kbLanguages.KbLanguage.code` (string) IETF code of the language. Enum: "en-US", "en-GB", "fr-FR", "es-ES", "it-IT", "de-DE", "nl-NL", "pt-BR", "pt-PT", "da-DK", "sv-SE", "ru-RU", "fr-CA", "zh-CN", "ja-JP", "ko-KR" - `portal.link` (object) Defines the relationship between this resource and another object. - `portal.link.rel` (string) Defines the relationship between a linked resource and the current object.For example: self, prev, next or an object name such as 'user', 'folder' etc. - `portal.link.href` (string) The URL that specifies the link's destination. - `paginationInfo` (object) - `paginationInfo.count` (integer, required) The total number of pages. - `paginationInfo.pagenum` (integer, required) The page number requested. Page numbers start from 1. - `paginationInfo.pagesize` (integer, required) The number of objects requested per page. The maximum number of objects per page is 75. - `paginationInfo.link` (array) Can include the prev and next link. ## Response 400 fields (application/json): - `code` (string, required) A string that follows the pattern {integer}-{integer}. The first {integer} is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header. ## Response 401 fields (application/json): - `code` (string, required) A string that follows the pattern {integer}-{integer}. The first {integer} is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header. ## Response 403 fields (application/json): - `code` (string, required) A string that follows the pattern {integer}-{integer}. The first {integer} is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header. ## Response 404 fields (application/json): - `code` (string, required) A string that follows the pattern {integer}-{integer}. The first {integer} is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header. ## Response 406 fields (application/json): - `code` (string, required) A string that follows the pattern {integer}-{integer}. The first {integer} is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header. ## Response 500 fields (application/json): - `code` (string, required) A string that follows the pattern {integer}-{integer}. The first {integer} is the http status code. This code as a whole is unique. * For example, error codes "400-101" and "404-101" are distinctly different. - `developerMessage` (string, required) A summary of the error. - `details` (array) - `details.key` (string, required) - `details.value` (string) - `userMessage` (string) UI friendly messages are only supported by some APIs. The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header. ## Response 204 fields