SupDesk
GET/v1/articles

List help center articles

Lists help center articles, with optional filters for status and category. Use limit and offset to control the number of results and where the list starts.

4 parameters
limitintegeroptional
Maximum number of articles to return, from 1 to 100. Defaults to 20 when omitted.
Default:20
offsetintegeroptional
Number of articles to skip. Must be 0 or greater. Defaults to 0 when omitted.
Default:0
statusstringoptional
Filter articles by status: `draft`, `published`, or `archived`.
Allowed:draftpublishedarchived
category_idstringoptional
Filter articles by the identifier of an article category.

2 status codes
200Returns an array of articles in `data` and pagination metadata containing the limit, offset, and whether more results are available.
dataarray<object>optional
paginationobjectoptional
401Returned when the request does not include valid authentication credentials.
errorobjectoptional

Error handling

A 401 is returned when the request does not include valid authentication credentials. limit must be between 1 and 100, offset must be 0 or greater, and status must be draft, published, or archived.