Skip to main content
GET
Fetch Spaces
Fetches a paginated list of spaces. Supports filtering by search query, membership, and parent space. Authentication is optional — if provided, member-only spaces the user belongs to are included.
This is a discovery surface: only public spaces are listed. Spaces with visibility of "unlisted" or "private" are excluded for non-members (they remain reachable by direct link/slug via Fetch Space by Slug or by Short ID). The exception is memberOf=true, which returns the caller’s own spaces regardless of visibility. See Space visibility.

Query Parameters

page
number
Page number. Defaults to 1.
limit
number
Results per page.
sortBy
string
Sort order: "alphabetical", "newest", or "members". Defaults to "members".
searchSlug
string
Filter by slug substring.
searchName
string
Filter by name substring.
searchDescription
string
Filter by description substring.
searchAny
string
Search across name, slug, and description simultaneously.
memberOf
boolean
When true, returns only spaces where the authenticated user is an active member.
parentSpaceId
string
Filter to child spaces of a specific parent. Pass "null" for root-level spaces only.
include
string
Optional comma-separated includes. Pass "files" to include avatar file objects.

Response

data
Space[]
Array of Space objects.
pagination
object
See also: useFetchManySpaces