Get Announcement Articles
Overview
The Get Announcement Articles API returns a portal's announcement articles. Only displayable announcement articles in the portal are returned.
Prerequisites
- For an article to display or be returned, set the Article type’s parameter, “Include in browse on portals,” to "Yes".
- Agents without a user profile and customers in a portal without a default user profile only have access to articles that:
- Do not contain any access tags.
- Do not contain any publish views.
- Contain publish views without any associated tags.
- Agents with a user profile and customers in a portal with a default user profile have access to articles that:
- Do not contain any access tags.
- Do not contain any publish views.
- Contain publish views without any associated tags.
- Contain access tags that are also in the assigned user profiles.
- Contain publish views with associated tags that are also in the assigned user profiles.
Permissions
- Agents with the following assigned actions can view updates to articles currently being processed in workflows:
- View Author Portal – Allows agents to view updates to articles at any stage in a workflow.
- View Staging Portal – Allows agents to view updates to articles in the Staging stage or a subsequent stage in a workflow.
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 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:
| Name | Description |
|---|---|
| id | The ID of the Article. |
| name | The name of the Article. |
| articleType | The Article Type and its attributes. |
| createdBy | The ID, first name, middle name and last name of the user that created the Article. |
| createdDate | The date that the Article was created. |
| hasAttachments | True: The Article has one or more attachments.False: The Article does not have any attachments. |
| languageCode | The language code of the Article language. |
| modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. |
| modifiedDate | The date that the Article was last modified on. |
| link | The link object, used to retrieve the details of the Article. |
| versionId | The ID of the Article version that is returned. |
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.
Value in
- "authoring"
- "staging"
- "publish"
The language that describes the details of a resource. Resources available in different languages may differ from each other.If lang is not passed, then the portal's default language is used.
Value in
- "en-US"
- "fr-FR"
- "en-GB"
- "es-ES"
- "it-IT"
- "nl-NL"
- "da-DA"
- "sv-SE"
- "pt-PT"
- "fi-FI"
- "no-NB"
- "no-NN"
- "ja-JA"
- "de-DE"
- "pt-BR"
- "zh-CN"
- "zh-TW"
- "ko-KO"
- "ru-RU"
- "el-EL"
- "tr-TR"
- "pl-PL"
- "cs-CS"
- "sk-SK"
- "hu-HU"
- "sr-SR"
- "ar-SA"
- "hr-HR"
- "ro-RO"
- "th-TH"
- "de-AT"
- "vi-VN"
- "id-ID"
- "ms-MY"
- "fil-PH"
- "fr-CA"
- "hi-IN"
- "uk-UA"
- "bg-BG"
- "sl-SI"
- "xx-XX"
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.
int641 <= value <= 7510Header 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/articles/announcements?articleResultAdditionalAttributes=averageRating" \ -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"{ "articles": [ { "id": "PROD-2996", "name": "Fair Lending FAQs", "articleType": { "articleCategoryId": 0, "typeName": "General", "useStructuredAuthoring": false, "articleTypeId": "988100000002020" }, "createdBy": { "id": "1013", "firstName": "John", "middleName": "", "lastName": "Doe" }, "createdDate": "2022-06-30T14:54:55Z", "hasAttachments": true, "languageCode": "en-US", "modifiedBy": { "id": "1013", "firstName": "John", "middleName": "", "lastName": "Doe" }, "modifiedDate": "2025-01-28T19:53:58Z", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996?filter%5Btopic%5D=PROD-1069&workflowMilestone=publish&%24lang=en-US" }, "versionId": "PROD-2884" } ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 }}Get Related Articles GET
## Overview The Get Related Articles API retrieves all related articles associated to a given article. ## Prerequisites * Set the Article type’s parameter “Include in browse on portals” to "Yes" for an article to be returned by this API. * Agents without a user profile and customers in a portal without a default user profile only have access to articles that: * Do not contain any access tags. * Do not contain any publish views. * Contain publish views without any associated tags. * Agents with a user profile and customers in a portal with a default user profile have access to articles that: * Do not contain any access tags. * Do not contain any publish views. * Contain publish views without any associated tags. * Contain access tags that are also in the assigned user profiles. * Contain publish views with associated tags that are also in the assigned user profiles. ## Permissions * Agents with the following assigned actions can view updates to articles currently being processed in workflows: * View Author Portal – Allows agents to view updates to articles at any stage in a workflow. * View Staging Portal – Allows agents to view updates to articles in the Staging stage or a subsequent stage in a workflow.
Get Article Ratings GET
## Overview The Get Article Ratings API returns ratings set for an Article. These ratings help you to assess the quality, helpfulness, or relevance of an article.

