Skip to main content
GET
https://api.usegately.com
/
api
/
v1
/
help
/
search
curl -X GET "https://api.usegately.com/api/v1/help/search?q=billing" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "success": true,
  "articles": [
    {
      "id": "art_456",
      "title": "Understanding Your Bill",
      "excerpt": "Learn about billing cycles...",
      "category_id": "cat_456",
      "view_count": 89
    }
  ],
  "query": "billing"
}
Search through help articles by keyword.

Query Parameters

q
string
required
Search query (minimum 2 characters)

Response

success
boolean
Whether the request was successful
articles
array
Array of matching articles
query
string
The search query used
curl -X GET "https://api.usegately.com/api/v1/help/search?q=billing" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "success": true,
  "articles": [
    {
      "id": "art_456",
      "title": "Understanding Your Bill",
      "excerpt": "Learn about billing cycles...",
      "category_id": "cat_456",
      "view_count": 89
    }
  ],
  "query": "billing"
}