Get All Topics

Tier	Tier Name	Named Users	Description
Tier 1	Starter	Up to 10	Designed for small-scale implementations or pilot environments
Tier 2	Growth	Up to 1000	Suitable for mid-scale deployments requiring moderate scalability
Tier 3	Enterprise	Greater than 1000	Supports large-scale environments with extended configuration options

Resource	Limits	Starter	Growth	Enterprise
Article Reference	Number of attachments used in any article	25	50	50
	Number of custom attributes in an article	10	25	50
	Number of publish views used in an article version	20	20	20
Topic Reference	User-defined topics in a department	1000	5000	50000
	Depth of topics	5	20	20
	Topics at any level	500	2500	2500
	Number of custom attributes in a topic	10	10	10
Portal Reference	Tag categories in a portal	15	15	15
	Topics to be included in a portal	100	500	5000
	Number of articles to display in announcements	10	25	25
	Usage links and link groups setup for a portal	5	10	25

Article

Article APIs

Operations

Article Lists

Article List APIs

Operations

Bookmark

Bookmark APIs

Operations

Guided Help

Guided Help APIs

Operations

Portal

Portal API

Operations

Search

Search APIs

Operations

Suggestion

Suggestion APIs

Operations

Topic

Topic APIs

Operations

Get Topic Breadcrumb for Article

Request

Overview

Use this API to retrieve the topic breadcrumb for an article in a portal. A breadcrumb shows the hierarchical path from the root topic to the article's primary topic.

Security

oAuthClient(Required scopes: )

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

articleIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

The ID of the Article.

An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.

Example: PROD-2996

Query

$langstringrequired

The language used for fetching the details of a resource. Resources available in different languages may differ from each other.

Enum"en-US""fr-FR""en-GB""es-ES""it-IT""nl-NL""da-DA""sv-SE""pt-PT""fi-FI"

Example: $lang=en-US

Headers

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

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

curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996/breadcrumb?%24lang=en-US' \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: string' \
  -H 'x-ext-interaction-id: string'

Responses

Success

Bodyapplication/json

topicBreadcrumbArray of objects(Topic Breadcrumb)

An array of TopicBreadcrumb instances representing individual paths.

Response

application/json

{
  "topicBreadcrumb": [
    { … },
    { … }
  ]
}

Get Immediate Child Topics

Request

Overview

The Get Immediate Child Topics API retrieves details about a topic and it's immediate child topics. The $level attribute determines how deep the topic hierarchy should go, or how many child topics of a topic are returned in the response.

Security

oAuthUser(Required scopes: ) or oAuthOnBehalfOfUser(Required scopes: ) or oAuthCustomer(Required scopes: ) or oAuthOnBehalfOfCustomer(Required scopes: ) or oAuthAnonymousCustomer(Required scopes: ) or oAuthClient(Required scopes: )

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

topicIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

The ID of a topic.

A topic ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Example: PROD-1069

Query

searchProfileIdstring[ 1 .. 15 ] characters

Search Profile ID

Example: searchProfileId=959500000204621

levelinteger(int64)[ -1 .. 20 ]

Depth of the topic hierarchy to be returned in the response.

Examples:

AllLevels

All levels are returned

level=-1

Parent

Only parent topic is returned

level=0

Immediate

Parent and immediate children topics are returned

level=1

Grand Children

Immediate children and grand children are returned

level=2

$langstring

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.

Enum"en-US""fr-FR""en-GB""es-ES""it-IT""nl-NL""da-DA""sv-SE""pt-PT""fi-FI"

Example: $lang=en-US

topicAdditionalAttributesArray of strings

The attributes of a topic 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 topic attributes are always returned:

Name	Description
id	The ID of the topic.
name	The name of the topic.
articleCountInTopic	Number of articles in this topic.
articleCountInTopicTree	Number of articles in this topic and all sub-topics.
createdBy.id	The ID of the user that created the topic.
createdDate	The date when the topic was created.
departmentId	ID of the department for which this topic belongs to.
topicHomeArticleId	The ID of the article used as the home page of this topic.
modifiedBy.id	The ID of the user that last modified the topic.
modifiedDate	The date when the topic was last modified on.
childCount	Total number of children sub-topis below the current topic
subTopicIds	Array with the list of sub-topics
parentTopicId	ID of the parent topic. -1 if it is the root topic.

Items Enum"description""createdBy.userName""createdBy.firstName""createdBy.lastName""createdBy.middleName""modifiedBy.userName""modifiedBy.firstName""modifiedBy.lastName""modifiedBy.middleName""imageUrl"

Examples:

Single

An additional attribute to be returned.

topicAdditionalAttributes=modifiedBy.userName

Multiple

Additional attributes to be returned.

topicAdditionalAttributes=description,imageUrl

All

All additional attributes to be returned.

topicAdditionalAttributes=all

$customAdditionalAttributesstring[ 1 .. 4000 ] characters^([a-zA-Z0-9_-]+)(?:,[a-zA-Z0-9_-]+)*$

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

Examples:

Single

A user-defined custom attribute.

$customAdditionalAttributes=country_name

Multiple

Multiple user-defined custom attributes.

$customAdditionalAttributes=internalScore,performance-rating_dept_923

$pagenuminteger(int32)[ 1 .. 999 ]

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

Default 1

$pagesizeinteger(int32)[ 1 .. 75 ]

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

Default 10

Headers

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

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-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237

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

curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/topics/PROD-1069?searchProfileId=959500000204621&level=1&%24lang=en-US&topicAdditionalAttributes=description&%24customAdditionalAttributes=string&%24pagenum=1&%24pagesize=10' \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: string' \
  -H 'x-ext-interaction-id: string'

Responses

Success

Bodyapplication/json

topicTreeArray of objects(Topic tree)

paginationInfoobject(PaginationInfo)

Response

application/json

{
  "topicTree": [
    { … }
  ]
}

Get All Ancestor Topics

Request

Overview

The Get All Ancestor Topics API retrieves the hierarchy from the root topic down to the given topic.

Security

oAuthUser(Required scopes: ) or oAuthOnBehalfOfUser(Required scopes: ) or oAuthCustomer(Required scopes: ) or oAuthOnBehalfOfCustomer(Required scopes: ) or oAuthAnonymousCustomer(Required scopes: )

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

topicIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

The ID of a topic.

A topic ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Example: PROD-1069

Query

$langstring

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.

Enum"en-US""fr-FR""en-GB""es-ES""it-IT""nl-NL""da-DA""sv-SE""pt-PT""fi-FI"

Example: $lang=en-US

topicAdditionalAttributesArray of strings

The attributes of a topic 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 topic attributes are always returned:

Name	Description
id	The ID of the topic.
name	The name of the topic.
articleCountInTopic	Number of articles in this topic.
articleCountInTopicTree	Number of articles in this topic and all sub-topics.
createdBy.id	The ID of the user that created the topic.
createdDate	The date when the topic was created.
departmentId	ID of the department for which this topic belongs to.
topicHomeArticleId	The ID of the article used as the home page of this topic.
modifiedBy.id	The ID of the user that last modified the topic.
modifiedDate	The date when the topic was last modified on.
childCount	Total number of children sub-topis below the current topic
subTopicIds	Array with the list of sub-topics
parentTopicId	ID of the parent topic. -1 if it is the root topic.

Items Enum"description""createdBy.userName""createdBy.firstName""createdBy.lastName""createdBy.middleName""modifiedBy.userName""modifiedBy.firstName""modifiedBy.lastName""modifiedBy.middleName""imageUrl"

Examples:

Single

An additional attribute to be returned.

topicAdditionalAttributes=modifiedBy.userName

Multiple

Additional attributes to be returned.

topicAdditionalAttributes=description,imageUrl

All

All additional attributes to be returned.

topicAdditionalAttributes=all

$customAdditionalAttributesstring[ 1 .. 4000 ] characters^([a-zA-Z0-9_-]+)(?:,[a-zA-Z0-9_-]+)*$

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

Examples:

Single

A user-defined custom attribute.

$customAdditionalAttributes=country_name

Multiple

Multiple user-defined custom attributes.

$customAdditionalAttributes=internalScore,performance-rating_dept_923

$pagenuminteger(int32)[ 1 .. 999 ]

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

Default 1

$pagesizeinteger(int32)[ 1 .. 75 ]

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

Default 10

Headers

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

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-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237

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

curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/topics/PROD-1069/parents?%24lang=en-US&topicAdditionalAttributes=description&%24customAdditionalAttributes=string&%24pagenum=1&%24pagesize=10' \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: string' \
  -H 'x-ext-interaction-id: string'

Responses

Success

Bodyapplication/json

topicArray of objects(Topic)

paginationInfoobject(PaginationInfo)

Response

application/json

{
  "topic": [
    { … }
  ],
  "paginationInfo": {
    "count": 1,
    "pagenum": 1,
    "pagesize": 10
  }
}

Get All Topics

Request

Overview

The Get All Topics API retrieves the topic tree for a portal. The $level attribute determines how deep the topic hierarchy should go, or how many child topics of a topic are returned in the response.

Security

oAuthUser(Required scopes: ) or oAuthCustomer(Required scopes: ) or oAuthClient(Required scopes: ) or oAuthOnBehalfOfUser(Required scopes: ) or oAuthOnBehalfOfCustomer(Required scopes: ) or oAuthAnonymousCustomer(Required scopes: )

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

searchProfileIdstring[ 1 .. 15 ] characters

Search Profile ID

Example: searchProfileId=959500000204621

levelinteger(int64)[ -1 .. 20 ]

Depth of the topic hierarchy to be returned in the response.

Examples:

AllLevels

All levels are returned

level=-1

Parent

Only parent topic is returned

level=0

Immediate

Parent and immediate children topics are returned

level=1

Grand Children

Immediate children and grand children are returned

level=2

$langstring

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.

Enum"en-US""fr-FR""en-GB""es-ES""it-IT""nl-NL""da-DA""sv-SE""pt-PT""fi-FI"

Example: $lang=en-US

topicAdditionalAttributesArray of strings

The attributes of a topic 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 topic attributes are always returned:

Name	Description
id	The ID of the topic.
name	The name of the topic.
articleCountInTopic	Number of articles in this topic.
articleCountInTopicTree	Number of articles in this topic and all sub-topics.
createdBy.id	The ID of the user that created the topic.
createdDate	The date when the topic was created.
departmentId	ID of the department for which this topic belongs to.
topicHomeArticleId	The ID of the article used as the home page of this topic.
modifiedBy.id	The ID of the user that last modified the topic.
modifiedDate	The date when the topic was last modified on.
childCount	Total number of children sub-topis below the current topic
subTopicIds	Array with the list of sub-topics
parentTopicId	ID of the parent topic. -1 if it is the root topic.

Items Enum"description""createdBy.userName""createdBy.firstName""createdBy.lastName""createdBy.middleName""modifiedBy.userName""modifiedBy.firstName""modifiedBy.lastName""modifiedBy.middleName""imageUrl"

Examples:

Single

An additional attribute to be returned.

topicAdditionalAttributes=modifiedBy.userName

Multiple

Additional attributes to be returned.

topicAdditionalAttributes=description,imageUrl

All

All additional attributes to be returned.

topicAdditionalAttributes=all

$customAdditionalAttributesstring[ 1 .. 4000 ] characters^([a-zA-Z0-9_-]+)(?:,[a-zA-Z0-9_-]+)*$

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

Examples:

Single

A user-defined custom attribute.

$customAdditionalAttributes=country_name

Multiple

Multiple user-defined custom attributes.

$customAdditionalAttributes=internalScore,performance-rating_dept_923

$pagenuminteger(int32)[ 1 .. 999 ]

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

Default 1

$pagesizeinteger(int32)[ 1 .. 75 ]

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

Default 10

Headers

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

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-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example: 59237

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

curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/topics?searchProfileId=959500000204621&level=1&%24lang=en-US&topicAdditionalAttributes=description&%24customAdditionalAttributes=string&%24pagenum=1&%24pagesize=10' \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: string' \
  -H 'x-ext-interaction-id: string'

Responses

Success

Bodyapplication/json

topicTreeArray of objects(Topic tree)

paginationInfoobject(PaginationInfo)

Response

application/json

{
  "topicTree": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

User Details

User Details APIs

Operations

User Milestones

User Milestones APIs

Operations

User Profile

UserProfile APIs

Operations

Federated Search Event

Federated Search Event API

Operations

Connectors Search Events

Connectors Search Event APIs

Operations

Attachment

Attachment Upload API

Operations

Export

Content Export APIs

Operations

Knowledge Portal Manager APIsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

License

Tiers

API Resource Limits

Article

Article Lists

Bookmark

Guided Help

Popular Articles

Portal

Search

Suggestion

Topic

Get Topic Breadcrumb for Article

Request

Overview

Responses

Was this helpful?

Get Immediate Child Topics

Request

Overview

Default Attributes

Responses

Was this helpful?

Get All Ancestor Topics

Request

Overview

Default Attributes

Responses

Was this helpful?

Get All Topics

Request

Overview

Default Attributes

Responses

Was this helpful?

User Details

User Milestones

User Profile

Federated Search Event

Connectors Search Events

Attachment

Export

Knowledge Portal Manager APIs
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code