Search

Introduction

Through these endpoints, you can query the entire system and retrieve blocks, users, and channels whose search index matches your query.

Attributes

term (String) A string representation of your search query
users (Array) An array of the users that match your search query
channels (Array) An array of the channels that match your search query
blocks (Array) An array of the blocks that match your search query
total_pages (Integer) If pagination is used, how many total pages there are in your request
current_page (Integer) If pagination is used, page requested
per (Integer) If pagination is used, items per page requested

GET /v2/search?q=:q

Performs a search


HTTP method: GET
Pagination: Yes
Requires authentication: No

GET /v2/search/users?q=:q

Performs a search


HTTP method: GET
Pagination: Yes
Requires authentication: No

GET /v2/search/channels?q=:q

Performs a search


HTTP method: GET
Pagination: Yes
Requires authentication: No

GET /v2/search/blocks?q=:q

Performs a search


HTTP method: GET
Pagination: Yes
Requires authentication: No