List Articles

REST method: GET
URL:  https://app.knowledgeowl.com/api/head/article.json

Request

Name
Type
Required
Notes
project_id
Knowledge Base ID
True

replaceSnippets
Boolean
False
Use this parameter to replace snippet merge codes that are within the article body. If omitted, snippets will remain in merge code form.

NOTE: Due to the extra processing power necessary to replace the snippets, snippets will only be replaced when a limit of 100 or less is specified. Calls that do not specify a limit will ignore the "replaceSnippets" parameter.

_fields
Array
False
Use to limit the information returned to specific article fields. For example, if you only want to query the status of an article, you would use _fields[]=status.
limit
Integer
False
Limit the number of returned results.

Filtering Results

You may filter results by passing fields like so:
https://app.knowledgeowl.com/api/head/article.json?status=published
 This example call will return only articles that are published.

You may create more complex filters like so:
 https://app.knowledgeowl.com/api/head/article.json?
status[$in][]=published&status[$in][]=review
 This example call will return articles that are either set to published or set to needs review.

Sorting Results

To sort the returned articles, you may use the following format:
https://app.knowledgeowl.com/api/head/article.json?sort[status]=-1
The data can be sorted by any available field in ascending (1) or descending (-1) order.