Skip to main content
Required scopes: support_config_read

Arguments

String
Forward pagination cursor — returns articles after it.
String
Backward pagination cursor — returns articles before it.
ID
Only articles this collection lists (collections), as shoppers and HelpCenterCollection.articles see them.
Int
Forward pagination: returns the first N articles (max 100, default 25). Use with after; mutually exclusive with last/before.
Int
Backward pagination: returns the last N articles (max 100, default 25). Use with before; mutually exclusive with first/after.
Which key to sort by. TITLE is A to Z; LAST_EDITED_AT is oldest first, never-saved articles first.
ID
Only articles listed by a collection this page lists (collections).
Boolean
Only published (true) or draft (false) articles.
String
Only articles whose title or body text contains this text, case-insensitive. The body is matched as shoppers read it, without HTML tags and with entities decoded. At most 200 characters.
Boolean
Reverses the direction orderBy sorts in.
Boolean
Only those shoppers see (true) or don’t (false), by visibleToShoppers. Pass true when answering a customer.

Returns

A paginated list of HelpCenterArticle items.

Example