Get Articles

GET {{baseUrl}}/km/kbs/:kbId/articles?next_page_token=<string>&page_size=30&include_contents=false&excluded=false&language=de

Get multiple knowledge base articles.

Scopes: zva:read:km_kbs

Rate Limit Label: LIGHT

Request Params

KeyDatatypeRequiredDescription
next_page_tokenstringUse to paginate through large result sets. A next_page_token property is returned in the response whenever the set of available results exceeds the current page size.
page_sizenumberThe number of records returned per page.
include_contentsbooleanWhether to include the article's contents in the response or not.
excludedbooleanWhether to query excluded articles or not.
languagestringThe language of the results.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:30,&quot;total_records&quot;:&quot;\u003cnumber\u003e&quot;,&quot;articles&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;external_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;kb_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;category&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;https://P/wpS&quot;,&quot;content&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;exclude&quot;:false,&quot;language&quot;:&quot;ko&quot;},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;external_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;kb_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;category&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;http://bR$W&quot;,&quot;content&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;exclude&quot;:false,&quot;language&quot;:&quot;fr&quot;}]}