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.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
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.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Query Parameters
The search filter applied to the list of suggestions by a user.
Value in
- "suggested"
- "pending"
- "declined"
- "approved"
Objects returned in server response are sorted based on the attribute supplied under $sort.
Value in
- "id"
- "name"
Common query parameter $order.Default value: asc
Value in
- "asc"
- "desc"
Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
int641 <= value <= 9991Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.Valid range of 5-75Default value: 25
int641 <= value <= 7525Header Parameters
A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9The 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.
^[\w\W]+$length <= 40A 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.
^[\w\W]+$length <= 40The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
Value in
- "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"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/suggestions?filter%5Bstatus%5D=suggested" \ -H "x-egain-activity-id: 59237" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "Accept-Language: en-US"{ "suggestion": [ { "link": [ { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/suggestions/PROD-3259" } ], "name": "Missing Article Information", "description": "Missing Account Type Information", "content": "<p>There should be an article that explains the account types offered. That would be very helpful.<br /></p>", "status": { "value": "suggested", "displayValue": "Suggested" }, "modifiedBy": { "firstName": "John", "middleName": "", "lastName": "Smith", "id": "1067" }, "modifiedDate": "2025-01-23T04:16:17.000Z", "language": { "code": "en-us", "label": "English (US)" }, "hasRelatedArticles": false, "hasAttachments": false, "hasComments": true, "customAttribute": [], "id": "PROD-3259" } ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 25 }}Hybrid Search GET
The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores.
Make a Suggestion POST
## Overview The Make a Suggestion API allows users to create an Article Suggestion from within a knowledge portal. ## Prerequisites * Enable the setting "Manage a Suggestion" for the portal specified in the URL. * If the user is a Customer, enable the setting "Allow Customer Access" for the portal. * If you want to add an attachment to a Suggestion, first call the Generate Signed URL to Upload API to add an attachment using the provided returned altID in attachment request.

