← Documentation home
GET/hyax-api/v1/community/threads/:id

Get forum thread

Returns full thread including content, forum, category, and author.

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/threads/clx_example_id' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "title": "Welcome thread",
    "content": "<p>Hello community!</p>",
    "slug": "welcome-thread",
    "status": "ACTIVE",
    "isPinned": false,
    "isLocked": false,
    "forum": {
      "id": "clx…",
      "name": "Announcements",
      "slug": "announcements",
      "category": { "id": "clx…", "name": "General", "slug": "general" }
    },
    "author": { "id": "ppl…", "name": "Jane", "email": "[email protected]", "avatarUrl": null, "isTeamMember": false },
    "replyCount": 3,
    "viewCount": 42,
    "createdAt": "2025-01-15T12:00:00.000Z",
    "updatedAt": "2025-01-15T12:00:00.000Z",
    "lastReplyAt": "2025-01-16T08:00:00.000Z"
  }
}