Get a List of Suggested Knowledge Base Articles

Retrieve a short list of knowledge base articles whose title or category name contains the search text. The newest articles come first. The results include unpublished and expired articles. If the text is the ID of an existing article, the API returns only that article. The API applies the category filter and the limit only to the 50 newest matching articles, so it can return fewer results than the limit.

Query Params
string
required
length ≥ 1
\S

The text to search for. The API suggests an article if its title, category, subCategory or thirdLevelCategory contains the text. The match is not case-sensitive. The text must contain at least one character that is not a space.

string
length ≥ 1

Filter results by top-level category. The value is the name of the category, as shown in the category field of the article.

integer
1 to 50
Defaults to 10

The number of items to return. The default is 10, and you can have up to 50.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json