Skip to main content
Required scopes: support_config_read

Arguments

String
Forward pagination cursor — returns collections after it.
String
Backward pagination cursor — returns collections before it.
Int
Forward pagination: returns the first N collections (max 100, default 25). Use with after; mutually exclusive with last/before.
Int
Backward pagination: returns the last N collections (max 100, default 25). Use with before; mutually exclusive with first/after.
Which key to sort by. TITLE is A to Z.
ID
Only collections this page lists.
Boolean
Only published (true) or unpublished (false) ones.
String
Only collections whose title or description contains this text, case-insensitive. 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 HelpCenterCollection items.

Example