Search topics

GET /api/2.0/community/forum/@search/{query}

Request

Returns a list of topics matching the search query specified in the request with the topic titles, dates of creation and update, post texts, and authors.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Path

querystring

Search query

Examples

GET /api/2.0/community/forum/@search/%7Bquery%7D HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/community/forum/@search/%7Bquery%7D \
  --header 'Accept: application/json'

Responses

200

List of topics

Idintegerformat: int32

Titlestring

Createdstring

Updatedstring

Textstring

UpdatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

ThreadTitilestring

Statusenum of integerformat: int32

[0 - Normal, 1 - Closed, 2 - Sticky]

Can be one of: Normal, Closed, Sticky.

Typeenum of integerformat: int32

[0 - Informational, 1 - Poll]

Can be one of: Informational, Poll.

Tagsarray of string

401

Unauthorized