GET/hyax-api/v1/helpdesk/articles

List helpdesk articles

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Query parameters

Name	Required	Description
page	No	Default 1
limit	No	Default 20, max 100
status	No	`DRAFT` \| `PUBLISHED`
categoryId	No	Filter by category ID
search	No	Filter by title or slug (case-insensitive contains)

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/helpdesk/articles?page=1&limit=10' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "title": "Getting started",
      "excerpt": "Learn the basics",
      "slug": "getting-started",
      "status": "PUBLISHED",
      "order": 0,
      "viewCount": 42,
      "categoryId": "clx…",
      "category": { "id": "clx…", "name": "Basics", "slug": "basics" },
      "createdAt": "2025-01-15T12:00:00.000Z",
      "updatedAt": "2025-01-15T12:00:00.000Z"
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}