Suggestion

Get Suggestion by Status

GET
/knowledge/portalmgr/v4/portals/{portalID}/suggestions

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
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

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.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20

Query Parameters

filter[status]*string

The search filter applied to the list of suggestions by a user.

Value in

  • "suggested"
  • "pending"
  • "declined"
  • "approved"
$sort?string

Objects returned in server response are sorted based on the attribute supplied under $sort.

Value in

  • "id"
  • "name"
$order?string

Common query parameter $order.Default value: asc

Value in

  • "asc"
  • "desc"
$pagenum?integer

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

Formatint64
Range1 <= value <= 999
Default1
$pagesize?integer

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.Valid range of 5-75Default value: 25

Formatint64
Range1 <= value <= 75
Default25

Header Parameters

x-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
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.

Match^[\w\W]+$
Lengthlength <= 40
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.

Match^[\w\W]+$
Lengthlength <= 40
Accept-Language*string

The 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  }}