Search for a term

GET

https://discourse.example.com/search.json

Search for a term

curl -X GET 'https://discourse.example.com/search.json?q=api%20%40blake%20%23support%20tags%3Aapi%20after%3A2021-06-04%20in%3Aunseen%20in%3Aopen%0Aorder%3Alatest_topic&page=1'

const response = await fetch('https://discourse.example.com/search.json?q=api%20%40blake%20%23support%20tags%3Aapi%20after%3A2021-06-04%20in%3Aunseen%20in%3Aopen%0Aorder%3Alatest_topic&page=1', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://discourse.example.com/search.json?q=api%20%40blake%20%23support%20tags%3Aapi%20after%3A2021-06-04%20in%3Aunseen%20in%3Aopen%0Aorder%3Alatest_topic&page=1')
print(response.text)

200

{
  "posts": [],
  "users": [],
  "categories": [],
  "tags": [
    {
      "id": 0,
      "name": "string",
      "slug": "string"
    }
  ],
  "groups": [],
  "grouped_search_result": {
    "more_posts": "string",
    "more_users": "string",
    "more_categories": "string",
    "term": "string",
    "search_log_id": 0,
    "more_full_page_results": "string",
    "can_create_topic": true,
    "error": "string",
    "extra": {
      "categories": []
    },
    "post_ids": [],
    "user_ids": [],
    "category_ids": [],
    "tag_ids": [],
    "group_ids": []
  }
}

Parameters

qstringquery

The query string needs to be url encoded and is made up of the following options:

Search term. This is just a string. Usually it would be the first item in the query.
@<username>: Use the @ followed by the username to specify posts by this user.
#<category>: Use the # followed by the category slug to search within this category.
tags:: api,solved or for posts that have all the specified tags api+solved.
before:: yyyy-mm-dd
after:: yyyy-mm-dd
order:: latest, likes, views, latest_topic
assigned:: username (without @)
in:: title, likes, personal, messages, seen, unseen, posted, created, watching, tracking, bookmarks, assigned, unassigned, first, pinned, wiki
with:: images
status:: open, closed, public, archived, noreplies, single_user, solved, unsolved
group:: group_name or group_id
group_messages:: group_name or group_id
min_posts:: 1
max_posts:: 10
min_views:: 1
max_views:: 10

If you are using cURL you can use the -G and the --data-urlencode flags to encode the query:

curl -i -sS -X GET -G "http://localhost:3000/search.json" \
--data-urlencode 'q=wordpress @scossar #fun after:2020-01-01'

pageintegerquery

Response

200OKany

success response

Response fields application/json

postsArray<any>required

usersArray<any>required

categoriesArray<any>required

tagsArray<object>required

Show child attributes

idintegerrequired

namestringrequired

slugstringrequired

groupsArray<any>required

grouped_search_resultobjectrequired

Show child attributes

more_postsstring | nullrequired

more_usersstring | nullrequired

more_categoriesstring | nullrequired

termstringrequired

search_log_idintegerrequired

more_full_page_resultsstring | nullrequired

can_create_topicbooleanrequired

errorstring | nullrequired

extraobject

Show child attributes

categoriesarray | null

post_idsArray<any>required

user_idsArray<any>required

category_idsArray<any>required

tag_idsArray<any>required

group_idsArray<any>required

Docs by Sourcey