GET/hyax-api/v1/community/forums

List forums

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

Query parameters

Name	Required	Description
categoryId	No	Filter by category ID
status	No	`ACTIVE` \| `ARCHIVED` \| `DRAFT`

Request examples

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

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

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "name": "Announcements",
      "slug": "announcements",
      "status": "ACTIVE",
      "categoryId": "clx…",
      "category": { "id": "clx…", "name": "General", "slug": "general" },
      "threadCount": 12
    }
  ]
}