Skip to main content

​
Overview

Search for spaces using a text query or a tag. Both endpoints are public and do not require authentication. Only public spaces appear in results. The SearchAPI function combines both search strategies — it runs a tag search and a full-text search in parallel and returns results separately, filtered to only public spaces.

​
Endpoints

​
Full-text search

GET /api/spaces/search?q={query}
Searches space titles and descriptions using the provided query string. 
GET /api/spaces/tag/{tag}
Returns all spaces tagged with the specified tag name.
No authentication required. Both endpoints are public.

​
Request

​
Full-text search — query parameters

​
q
string
required
The search query string. URL-encoded automatically when using SearchAPI.

​
Tag search — path parameters

​
tag
string
required
The tag name to filter spaces by.

​
Response

Both endpoints return an array of SearchResult objects. SearchAPI returns an object with two arrays.

​
SearchResult fields

​
space_id
string
Unique identifier for the space.
​
title
string
Display title of the space.
​
description
string
Short description of the space.
​
visibility
string
Always "public" for results returned by these endpoints.
​
creator
object
The user who created the space.
​
participant_count
number
Number of participants currently in the space.
​
tags
array
Tags associated with the space.

​
SearchAPI response shape

​
tagSearchResults
SearchResult[]
Spaces matching the query via tag search, filtered to public only.
​
generalSearchResults
SearchResult[]
Spaces matching the query via full-text search, filtered to public only.

​
Example

TypeScript
import { SearchAPI } from "./api/Search";

const { tagSearchResults, generalSearchResults } = await SearchAPI("design");

console.log(tagSearchResults);
// Spaces tagged with "design"
// [
//   {
//     space_id: "xyz789",
//     title: "Design Systems",
//     description: "A space for UI/UX designers",
//     visibility: "public",
//     creator: { user_id: "u2", username: "bob", profile_picture: "https://..." },
//     participant_count: 18,
//     tags: [{ tag_id: 3, tag_name: "design" }]
//   }
// ]

console.log(generalSearchResults);
// Spaces matching "design" in title or description

// Empty query returns empty results immediately (no network request)
const emptyResult = await SearchAPI("   ");
// { tagSearchResults: [], generalSearchResults: [] }