GET /api/topics/search

get a list of topics that match the given search criteria

Success Response Code: 200

Params

Param name Description
q
optional

query string to match against. Matches against the topic name, title or description


Value: Must be a String
name_prefix
optional

filters to only show topics that start with the requested name


Value: Must be a String

Response Fields

topics topics array of topic entries Array<Topic>
topic[id] id of topic Integer
topic[name] name of topic String
topic[description] topic's description String
topic[html_description] topic's description with markdown applied, if applicable String
topic[url] url to interact with topic String
topic[avatars] set of images of various sizes to represent a topic Array<Avatars>

Examples

GET /topics/search.json
200
{
  "topics": []
}