Search in the titles of forum threads in a specific group.

GET

/api/search/forum/{groupId}/{subforumId}

Authorizations

api_key

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

Parameters

Path Parameters

groupId*

Which forum to return threads for (region or group)

Typeinteger

Required

subforumId*

ID of the forum in the group (normal or ambassador forum)

Typeinteger

Required

Query Parameters

q

Search query

Typestring

Responses

Success

Content-Type

Use example

[

{

"id": 1,

"name": "Name",

"search_string": "Münster;meunster",

"time": "2023-10-04 15:21:52",

"stickiness": 1,

"is_closed": true,

"is_inside_ambassador_forum": true,

"region_id": 1,

"region_name": "Münster"

}

]

GET

/api/search/forum/{groupId}/{subforumId}

Authorization

api_key

Variables

Key

Value

groupId*

subforumId*

q

curl -X GET \
'http://localhost/api/search/forum/{groupId}/{subforumId}'

Samples

cURL

curl -X GET http://localhost/api/search/forum/{groupId}/{subforumId}

JavaScript

fetch("http://localhost/api/search/forum/{groupId}/{subforumId}")
  .then(response => response.json())
  .then(data => console.log(data));

PHP

file_get_contents("http://localhost/api/search/forum/{groupId}/{subforumId}");

Python

import requests
response = requests.get("http://localhost/api/search/forum/{groupId}/{subforumId}")
print(response.json())