Newer Version Available

This content describes an older version of this product. View Latest

Support Knowledge with REST API

Knowledge Support REST APIs allow both authorized and guest users to retrieve the user’s visible data categories and their associated articles.

Authenticated users need the UserProfile.apiEnabled permission, Knowledge enabled in the organization, read rights on the article type, and any other knowledge specific permission or preference that controls visibility to articles.

Guest users need the Guest Access to the Support API preference enabled on the relevant Site, Knowledge enabled in the organization, and read rights on the article type and article channel that controls the visibility for guest users.

Syntax

The root endpoint for all Knowledge support APIs that can be open to guest users.

Available since release
38.0
Method
GET
Formats
JSON, XML
Authentication
OAuth accesstoken
Endpoint
<prefix>/support
HTTP headers
Accept: Optional. Can be either application/json or application/xml.
Input
None
Output
The following resources are related to Knowledge.
1{
2"dataCategoryGroups" : "/services/data/vxx.0/support/dataCategoryGroups",
3"knowledgeArticles" : "/services/data/vxx.0/support/knowledgeArticles"
4:
5}
Where vxx.0 is the API version you requested.