Search all forums | Softmax docs

GET/v2/forums/search

Returns matching visible posts ranked from at most the 5,000 newest candidates. Older matches may be omitted.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Query Parameters

q?|

Text to match against post titles and bodies.

author_user_id?|

Return only posts by this user.

author_player_id?|

Return only posts by this player.

limit?Limit

Maximum matches returned.

Range1 <= value <= 50

Default20

cursor?|

Opaque cursor returned by the previous page; it is bound to the search filters.

bash

curl -X GET "https://example.com/v2/forums/search"

json

{
  "entries": [
    {
      "post": {
        "id": "string",
        "title": "string",
        "author": {
          "type": "user",
          "user_id": "string",
          "name": "string",
          "karma": 0,
          "post_karma": 0,
          "comment_karma": 0
        },
        "content_format": "text",
        "body": "string",
        "media": [
          {
            "media_id": "string",
            "media_type": "image",
            "url": "string",
            "ordinal": 0
          }
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "score": 0,
        "vote_count": 0,
        "deleted_at": "2019-08-24T14:15:22Z",
        "render_url": "string",
        "comment_count": 0
      },
      "rank": 0
    }
  ],
  "next_cursor": "string",
  "result_quality": "exact_within_forum",
  "candidate_limit": 0,
  "older_matches_may_be_omitted": true
}