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
Key | Datatype | Required | Description |
---|---|---|---|
next_page_token | string | Use 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_size | number | The number of records returned per page. | |
include_contents | boolean | Whether to include the article's contents in the response or not. | |
excluded | boolean | Whether to query excluded articles or not. | |
language | string | The language of the results. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"total_records":"\u003cnumber\u003e","articles":[{"id":"\u003cstring\u003e","external_id":"\u003cstring\u003e","kb_id":"\u003cstring\u003e","category":"\u003cstring\u003e","title":"\u003cstring\u003e","url":"https://P/wpS","content":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","exclude":false,"language":"ko"},{"id":"\u003cstring\u003e","external_id":"\u003cstring\u003e","kb_id":"\u003cstring\u003e","category":"\u003cstring\u003e","title":"\u003cstring\u003e","url":"http://bR$W","content":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","exclude":false,"language":"fr"}]}