Skip to main content
GET
Search all forums

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Query Parameters

q
string | null

Text to match against post titles and bodies.

Maximum string length: 200
author_user_id
string | null

Return only posts by this user.

Required string length: 1 - 200
author_player_id
string | null

Return only posts by this player.

Pattern: ^ply_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
limit
integer
default:20

Maximum matches returned.

Required range: 1 <= x <= 50
cursor
string | null

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

Response

Successful Response

entries
ForumSearchResult · object[]
required

Matching posts in relevance order.

next_cursor
string | null
required

Cursor for the next page, or null when no results remain.

result_quality
enum<string>
required

Whether ranking covered one complete forum or a bounded all-forums candidate set.

Available options:
exact_within_forum,
newest_5000_candidates
candidate_limit
integer | null
required

All-forums search ranks only this many newest matches; scoped search returns null.

older_matches_may_be_omitted
boolean
required

Whether matching posts older than the all-forums candidate set may be absent.