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. This resource is available in REST API version 38.0 and later.

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.

URI: /services/data/vXX.X/support

Method: GET

Formats: JSON, XML

Authentication: Authorization: Bearer token

Example Response Body

• Data Category Groups

  Get data category groups that are visible to the current user. This resource is available in REST API version 38.0 and later.

• Data Category Detail

  Gets data category details and the child categories by a given category. This resource can be used in API version 38.0 and later.

• Articles List

  Get a page of online articles for the given language and category through either search or query. This resource is available in REST API version 38.0 and later.

• Articles Details

  Gets all online article fields, accessible to the user. This resource is available with article IDs in REST API version 38.0 and later, and this resource is available with article URL names in version 44.0 and later.