Skip Navigation

Search Knowledge Articles

Searches for knowledge articles with specified search terms, language, data category group, and data category.

This object is available in API version 56.0 and later.

Supported REST HTTP Methods

URI: /services/data/v56.0/actions/standard/searchKnowledgeArticles
Formats: JSON, XML
HTTP Methods: GET, HEAD, POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
searchText	Type string Description Search terms to be used in the knowledge article search.
languageCode	Type string Description The language code to be used in a knowledge article search. Valid values are language codes for fully supported languages.
dataCategoryGroupName	Type string Description The API name of the data category group to be used in the knowledge article search.
dataCategoryName	Type string Description The API name of the data category to be used in the knowledge article search.
resultsLimit	Type integer Description Optional. The maximum number of knowledge articles to return. Valid values are from 1 through 2000. By default, the maximum is 2000.

Outputs

Output	Details
knoweldgeArticlesList	Type Apex Description An Apex knowledge_bot__ArticlesList record that contains information about the knowledge articles that were returned.