Support Articles

Search and list help center articles

Returns published, non-internal Check Cherry help center articles. Use this to answer customer questions about how the platform works (booking flow, payments, leads, integrations, etc.) instead of guessing.

Filter by category to scope the list, or pass text to run a full-text search across the article title, body, and meta description. When text is present results are ranked by relevance; otherwise articles are returned in display order within their category.

Required permission: global

get/api/v1/support_articles

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/support_articles
  • Auth: none declared. Required headers: Api-Key

Query parameters

textstring

Full-text search query across article title, body, and meta description

categorystring

Filter by article category (e.g., bookings, leads, payments)

pageinteger

Page number (default: 1)

perinteger

Results per page (default: 20)

Headers

Api-Keystring required

Your Integration Key

Response

support articles found

Changes

No recorded changes to this operation across all 2 revisions of this API.