Skip to content
Knowledge APIs
/
/
/
My Subscription

My Subscription

Request

Overview

The My Subscription API allows authenticated users and agents to retrieve the list of articles to which they are subscribed.

Security
oAuthUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
)
Path
portalIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$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
workflowMilestonestring

For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.

  • 'Authoring' returns the most recent version of an Article checked-in by an author.
  • 'Staging' returns the updated version currently being processed in a workflow.
  • 'Publish' returns the most recently published version.

    • Enum:"authoring""staging""publish"
    Example:workflowMilestone=publish
    $pagenuminteger, (int64), [ 1 .. 999 ]

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

    Default:1
    $pagesizeinteger, (int64), [ 1 .. 75 ]

    Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

    Default:10
    articleResultAdditionalAttributesArray of strings

    The attributes of an Article 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' will return all attributes.

    Default Attributes

    These Article attributes are always returned:

    NameDescription
    idThe ID of the Article.
    nameThe name of the Article.
    articleTypeThe Article Type and its attributes.
    createdByThe ID, first name, middle name and last name of the user that created the Article.
    createdDateThe date that the Article was created.
    hasAttachmentsTrue: The Article has one or more attachments.
    False: The Article does not have any attachments.
    languageCodeThe language code of the Article language.
    modifiedByThe ID, first name, middle name and last name of the user that last modified the Article.
    modifiedDateThe date that the Article was last modified on.
    linkThe link object, used to retrieve the details of the Article.
    versionIdThe ID of the Article version that is returned.
    Items Enum:"averageRating""customAttributes""description""articleSummary""imageURL""isSubscribed""timesRated""topicBreadcrumb""ownedBy""ownedBy.userName"
    Examples:
    Single
    An additional attribute to be returned.
    articleResultAdditionalAttributes=["averageRating"]
    Multiple
    Additional attributes to be returned.
    articleResultAdditionalAttributes=["ownedBy","ownedBy.userName"]
    All
    All additional attributes to be returned.
    articleResultAdditionalAttributes=["all"]
    Headers
    x-egain-activity-idstring, [ 4 .. 9 ] characters^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example:59237
    x-ext-integration-idstring, <= 40 characters^[\w\W]+$

    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.

    Examples:
    uuid
    3155180e-0c13-43e9-9c38-e9045bcbf176
    hex
    00Dbn00000IxGnx
    x-ext-interaction-idstring, <= 40 characters^[\w\W]+$

    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.

    Examples:
    uuid
    3155180e-0c13-43e9-9c38-e9045bcbf176
    hex
    00Dbn00000IxGnx
    Accept-Languagestringrequired

    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"
    Example:en-US
    GET
    /portals/{portalID}/articles/subscribed
    curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articles/subscribed?workflowMilestone=publish&%24pagenum=1&%24pagesize=10&articleResultAdditionalAttributes=averageRating' \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -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'

    Responses

    Success

    Bodyapplication/json
    articlesArray of objects(ArticleResult)

    Article details

    paginationInfoobject(PaginationInfo)
    Response
    {
  "articles": [
    { … }
  ],
  "paginationInfo": {
    "count": 1,
    "pagenum": 1,
    "pagesize": 10
  }
}