Suggestion

Get Suggestion by ID

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

Overview

The Get Suggestion by ID API allows authenticated users to retrieve their own suggestions.

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.
  • The "Suggestion for the ID" specified in the URL must belong to the user.

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
suggestionID*string

The ID of the Suggestion.A Suggestion 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

suggestionAdditionalAttributes?array<>

The attributes of a Suggestion to be returned in addition to the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' returns all attributes.

Default Attributes

These Suggestion attributes are always returned:

NameDescription
idThe ID of the Suggestion.
nameThe name of the Suggestion.
statusThe status of the Suggestion.
descriptionThe description of the Suggestion.
languageDetails about the language of the Suggestion.
modifiedBy.idThe ID of the user that last modified the Suggestion.
modifiedBy.firstNameThe Suggestion's last modified user's first name.
modifiedBy.middleNameThe Suggestion's last modified user's middle name.
modifiedBy.lastNameThe Suggestion's last modified user's last name.
modifiedDateThe Suggestion's last modified date and information about the user that last modified the Suggestion.
linkThe link object, used to retrieve the details of the Suggestion.
hasCommentsThe Suggestion has one or more comments
hasAttachmentsThe Suggestion has one or more attachments
hasRelatedArticlesThe Suggestion has related articles
$customAdditionalAttributes?string

One or more comma-separated names for custom attributes defined by the user to be returned.

Match^([a-zA-Z0-9_-]+)(?:,[a-zA-Z0-9_-]+)*$
Length1 <= length <= 4000

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/PROD-11829?suggestionAdditionalAttributes=content&%24customAdditionalAttributes=country_name" \  -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"
{  "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"  },  "hasRelatedArticles": false,  "hasAttachments": false,  "hasComments": true,  "customAttribute": [],  "id": "PROD-3259"}