Skip to content

Search threads in a specific forum​

GET
/api/search/regions/{regionId}/forum

Authorizations​

api_key

Requests manipulating data need to supply a CSRF token

Type
API Key (header: X-CSRF-Token)

Parameters​

Path Parameters

regionId*
Type
integer
Required
Minimum
1

Query Parameters

q*
Type
string
Required
Pattern
"^.+$"
includeBody
Type
[ "boolean", "null" ]
subforumId
Type
[ "integer", "null" ]
Minimum
0

Responses​

Success

application/json
JSON
[
  
{
  
  
"id": 1,
  
  
"name": "Name",
  
  
"searchString": "Münster;meunster",
  
  
"lastPostSentAt": "string",
  
  
"pinnedLevel": 1,
  
  
"isClosed": true,
  
  
"isInsideAmbassadorForum": true,
  
  
"postId": 42,
  
  
"regionId": 0,
  
  
"regionName": "Münster",
  
  
"body": "This is the body of the thread",
  
  
"relevance": 0.85
  
}
]

Playground​

Authorization
Variables
Key
Value

Samples​