Get a List of Knowledge Base Articles

get

https://{account}.sysaidit.com/connect/v1/kb-articles

Retrieve a paginated list of knowledge base articles in your SysAid account. The API sorts the results by ID, lowest ID first. The query parameter matches the articles whose title, question, answer or keywords contain all the words in the text, in any letter case. The query text can have a maximum of 100 characters. If the user is not an Admin, the API returns a 401 error.

Query Params

limit

integer

1 to 500

Defaults to 100

The number of items to display per page. The default is 100, and you can have up to 500.

offset

integer

≥ 0

Defaults to 0

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

query

string

Query to search entities.

publish

boolean

Filter results by publication state. If the value is "true", the API returns only published articles, including expired articles. If the value is "false", the API returns only unpublished drafts. If you do not send this parameter, the API returns articles in both states.

200Knowledge base article list.

400The request was invalid or cannot be served

401Authentication information is missing or invalid

403The server understood the request but refuses to authorize it