GET/hyax-api/v1/community/categories

List forum categories

Returns categories with nested forums and forum counts.

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

Request examples

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

curl -X GET 'https://platform.hyax.com/hyax-api/v1/community/categories' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "name": "General",
      "description": null,
      "slug": "general",
      "order": 0,
      "forumCount": 2,
      "forums": [
        { "id": "clx…", "name": "Announcements", "slug": "announcements", "status": "ACTIVE", "order": 0 }
      ],
      "createdAt": "2025-01-15T12:00:00.000Z",
      "updatedAt": "2025-01-15T12:00:00.000Z"
    }
  ]
}