# Get Suggestion by Status ## Overview The Get Suggestion by Status API allows authenticated users to retrieve their own suggestions based on Suggestion status. ## Prerequisites * Enable the setting "My Suggestions" for the portal specified in the URL. * If the user is a customer, enable the setting "Allow Customer Access" for the portal. Endpoint: GET /portals/{portalID}/suggestions Security: oAuthUser, oAuthOnBehalfOfUser, oAuthCustomer, oAuthOnBehalfOfCustomer ## 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" ## Path parameters: - `portalID` (string, required) The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. Example: "PROD-1000" ## Query parameters: - `filter[status]` (string, required) The search filter applied to the list of suggestions by a user. Enum: "suggested", "pending", "declined", "approved" - `$sort` (string) Objects returned in server response are sorted based on the attribute supplied under $sort. Enum: "id", "name" - `$order` (string) Common query parameter $order._Default value_: asc Enum: "asc", "desc" - `$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.Valid range of 5-75_Default value_: 25 ## Response 200 fields (application/json): - `Suggestion` (array) - `Suggestion.id` (string, required) The ID of the Suggestion. A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. Example: "PROD-0623" - `Suggestion.link` (object) Defines the relationship between this resource and another object. - `Suggestion.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. - `Suggestion.link.href` (string) The URL that specifies the link's destination. - `Suggestion.name` (string, required) The name of the Suggestion. - `Suggestion.description` (string) The description of the Suggestion. - `Suggestion.content` (string) The content of the Suggestion. - `Suggestion.hasRelatedArticles` (boolean) If true, the Suggestion has one or more Related Articles. - `Suggestion.status` (object) The status of the Suggestion. 1 : suggested. 2 : pending 3 : declined 4 : approved - `Suggestion.status.value` (string) A string that indicates the value. - `Suggestion.status.displayValue` (string) Localized string of the value element. - `Suggestion.modifiedBy` (object) - `Suggestion.modifiedBy.id` (string) The ID of the user that modified this resource. - `Suggestion.modifiedBy.userName` (string) The resource modifier's username. - `Suggestion.modifiedBy.firstName` (string) The resource modifier's first name. - `Suggestion.modifiedBy.middleName` (string) The resource modifier's middle name. - `Suggestion.modifiedBy.lastName` (string) The resource modifier's last name. - `Suggestion.modifiedDate` (string) The last modified date and last modifying user of the Suggestion. - `Suggestion.hasAttachments` (boolean) Indicates whether the Suggestion has any Attachments. - `Suggestion.hasComments` (boolean) Indicates whether the Suggestion has any comments. - `Suggestion.language` (object) The knowledge base language in which the Suggestion was created. - `Suggestion.language.code` (string, required) The language that describes the details of the resource. Resources available in different languages may differ from each other. 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", "zh-CN", "ja-JP", "ko-KR", "de-AT", "th-TH", "vi-VN", "id-ID", "ms-MY", "fil-PH", "fr-CA", "hi-IN", "uk-UA", "bg-BG", "sk-SK", "sl-SI" - `Suggestion.language.label` (string) The name of the language. Enum: "English", "French", "Spanish", "Italian", "German", "Dutch", "Portuguese", "Danish", "Swedish", "Russian", "Chinese", "Japanese", "Korean", "Thai", "Vietnamese", "Indonesian", "Malay", "Filipino", "Hindi", "Ukrainian", "Bulgarian", "Slovak", "Slovene", "Serbian" - `Suggestion.customAttributes` (array) Custom Attributes of the Suggestion. - `Suggestion.customAttributes.name` (string) The custom attribute's name. - `Suggestion.customAttributes.value` (array) The custom attribute's values. - `Suggestion.customAttributes.type` (string) The custom attribute's type. Enum: "STRING", "INTEGER", "BOOLEAN", "DATETIME" - `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