SupDesk API
GET/v1/articles

List help center articles

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

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 before returning results. 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 unique identifier of an article category.

2 status codes
200Returns an array of article objects in `data` and pagination metadata including `limit`, `offset`, and `has_more`.
dataarray<object>optional
paginationobjectoptional
401Returned when the request lacks valid authentication credentials.
errorobjectoptional

Error handling

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