Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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

Outputs

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