GET/hyax-api/v1/community/threads

List forum threads

Cursor-paginated thread list. Omit `forumId` to search across all team forums.

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

Query parameters

Name	Required	Description
forumId	No	Optional forum ID scope
status	No	`ACTIVE` \| `ARCHIVED` \| `DRAFT`
search	No	Filter by title (case-insensitive contains)
limit	No	Default 20, max 100
cursor	No	Thread ID cursor from previous response

Request examples

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

curl -X GET 'https://platform.hyax.com/hyax-api/v1/community/threads?limit=10' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "title": "Welcome thread",
      "slug": "welcome-thread",
      "status": "ACTIVE",
      "isPinned": false,
      "isLocked": false,
      "forum": { "id": "clx…", "name": "Announcements", "slug": "announcements" },
      "author": { "id": "ppl…", "name": "Jane", "email": "[email protected]", "avatarUrl": null, "isTeamMember": false },
      "replyCount": 3,
      "createdAt": "2025-01-15T12:00:00.000Z",
      "updatedAt": "2025-01-15T12:00:00.000Z",
      "lastReplyAt": "2025-01-16T08:00:00.000Z"
    }
  ],
  "nextCursor": null
}