List All Knowledge Base Items

Return a list of all articles, events and files matching the search parameters.

Using the /kbitems endpoint serves two purposes:

  • aggregated queries across resource types

  • listing of shared knowledge resources

Sharing kbitems

As with other resources, by default you only have access to kbitems in or below your organization. However, unlike other resources, organizations higher-up may decide to share kbitems by giving your organization viewing rights. They can do this by tagging kbitems with tags matching the tags set for your organization.

To view kbitems within your organization tree as well as (inclusive of) kbitems shared with you from higher-up, specify the matchTag parameter.

Consider the following requests, requested by a level-2 admin for organization 456 (orgPath 123#456) tagged foo,baz. Given four articles in existence (two shared by parent org, two owned by own org, and one owned by child org 789), "V" indicates the article showing up in results:

Article/kbtitems/kbtitems?matchTag=true/kbtitems?organization=456/kbtitems?matchTag=true&organization=456/kbtitems?matchTag=true&organization=123
org/orgPath:123 tags:foo-V--V
org/orgPath:123 tags:bar,baz-V--V
org:456, orgPath:123#456VVVV-
org:456, orgPath:123#456, tags:barVVVV-
org:789, orgPath:123#456#789VV---

In contrast, a level-3 admin for organization 789 with the single organization.tags bar would receive the following for the same requests:

Article/kbtitems/kbtitems?matchTag=true/kbtitems?organization=456/kbtitems?matchTag=true&organization=456/kbtitems?matchTag=true&organization=123
org/orgPath:123 tags:foo-----
org/orgPath:123 tags:bar,baz-V--V
org:456, orgPath:123#456-----
org:456, orgPath:123#456, tags:bar-V-V-
org:789, orgPath:123#456#789VV---

In short, adding matchTag will make your query inclusive of upper-level shared kbitems (while still applying other filters).

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!