Sign in
forum-sections

(optional authentication) Forum section get threads.

This endpoint will retrieve the threads in a forum section.

get/forum-sections/{sectionID}/threads

Path parameters

sectionIDinteger required

ID of the forum section.

Query parameters

order'best' | 'top' | 'new' | 'old' | 'poor' | 'controversial' required

The set of available forum sort types.

  • best: sorted by the most well received resource.
  • top: sorted by the most liked resource.
  • new: sorted by the newly created resource at the top.
  • old: sorted by the oldest created resource.
  • poor: sorted by the least liked resource.
  • controversial: sorted by the least well received resource.

The method of ordering the threads.

pagestring

The next page or group of objects to fetch. The default value is 1.

limitstring

The limit on the number of objects, or number of objects in the specified relationship, that are returned. The default value is 25 and the maximum value is 100.

Response

Successful GET Forum-Sections Threads JSON response.

object required

Example response

{
  "data": [
    {
      "id": 1,
      "type": "threads",
      "href": "/v1/forum-threads/1",
      "attributes": {
        "title": "Enim quia molestiae.",
        "content": "Fuga repellendus blanditiis quaerat provident et doloremque. Ad ullam nulla at optio ipsa ipsum.",
        "isLocked": false,
        "replyCount": 13,
        "metrics": {
          "count": 20,
          "weight": 10,
          "likes": 15,
          "dislikes": 5
        },
        "createdAt": "2020-07-27 12:59:34",
        "voteAction": 1
      },
      "relationships": {
        "user": {
          "data": [
            {
              "id": 29,
              "type": "users",
              "href": "/v1/users/29/profile",
              "attributes": {
                "username": "reynold71",
                "activityStatus": "Offline",
                "biography": "Et in dolor illo sit non. Veniam est et qui qui atque. Ut mollitia autem accusantium ea molestiae voluptatem a. Dicta in qui necessitatibus maiores.",
                "profileImageURL": null,
                "bannerImageURL": null,
                "followerCount": 67,
                "followingCount": 67,
                "reputationCount": 59,
                "isFollowed": false
              }
            }
          ]
        }
      }
    },
    {
      "id": 2,
      "type": "threads",
      "href": "/v1/forum-threads/2",
      "attributes": {
        "title": "Voluptatem possimus sunt.",
        "content": "Cupiditate voluptatem quaerat eaque veniam atque. Id et fugiat dolore nihil necessitatibus ut quia tempore. Natus aspernatur consequatur dolores dolore ea consequatur rerum possimus.",
        "isLocked": true,
        "replyCount": 2,
        "metrics": {
          "count": 0,
          "weight": 0,
          "likes": 0,
          "dislikes": 0
        },
        "createdAt": "2020-07-27 12:59:34",
        "voteAction": 1
      },
      "relationships": {
        "user": {
          "data": [
            {
              "id": 29,
              "type": "users",
              "href": "/v1/users/29/profile",
              "attributes": {
                "username": "reynold71",
                "activityStatus": "Offline",
                "biography": "Et in dolor illo sit non. Veniam est et qui qui atque. Ut mollitia autem accusantium ea molestiae voluptatem a. Dicta in qui necessitatibus maiores.",
                "profileImageURL": null,
                "bannerImageURL": null,
                "followerCount": 67,
                "followingCount": 67,
                "reputationCount": 59,
                "isFollowed": false
              }
            }
          ]
        }
      }
    }
  ]
}

Changes