Articles List
GET {{_endpoint}}/services/data/v{{version}}/support/knowledgeArticles
Get a page of online articles for the given language and category through either search or query.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
q | null | Optional, Performs an SOSL search. If the query string is null, empty, or not given, an SOQL query runs. | |
channel | null | Optional, defaults to user’s context. For information on channel values, see Valid channel values. | |
| App: Visible in the internal Salesforce Knowledge application | |||
| Pkb: Visible in the public knowledge base | |||
| Csp: Visible in the Customer Portal | |||
| Prm: Visible in the Partner Portal | |||
categories | null | Optional, defaults to None. Category group must be unique in each group:category pair, otherwise you get ARGUMENT_OBJECT_PARSE_ERROR | |
queryMethod | null | values are: AT, BELOW, ABOVE, ABOVE_OR_BELOW. Only valid when categories are specified, defaults to ABOVE_OR_BELOW | |
sort | null | Optional, a sortable field name LastPublishedDate, CreatedDate, Title, ViewScore. Defaults to LastPublishedDate for query and relevance for search. | |
order | null | Optional, either ASC or DESC, defaults to DESC. Valid only when sort is valid | |
pageSize | null | Optional, defaults to 20. Valid range 1 to 100 | |
pageNumber | null | Optional, defaults to 1 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |