← Home
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

NameRequiredDescription
categoryIdNoFilter by category ID
statusNo`ACTIVE` | `ARCHIVED` | `DRAFT`

Request 

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

Response 

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