Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.docs.onlydrams.app/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

query
string
Search communities by name (case-insensitive, partial match)
filter
string
default:"all"
Filter communities by category: all, trending, or my_communities
page
integer
default:"1"
Page number for pagination
per
integer
default:"20"
Number of communities per page

Response

total
integer
Total number of communities matching the query/filter
has_more
boolean
Whether there are more communities available
data
array
Array of community objects

Filter Options

FilterDescription
allReturns all active communities (default)
trendingReturns communities marked as trending
my_communitiesReturns only communities where the user has an active membership

Frontend Usage

Use is_member and tier_badge to determine UI state:
ConditionButtonShow Tier Badge
is_member: true”View”Yes (display tier_badge value)
is_member: false”Explore”No
{
  "total": 156,
  "has_more": true,
  "data": [
    {
      "id": "b2c3d4e5-6789-01ab-cdef-234567890abc",
      "name": "RD One",
      "slug": "rd-one",
      "member_count": 650,
      "avatar_url": "https://storage.onlydrams.com/communities/avatars/rd-one.png",
      "tier_badge": "VIP",
      "is_member": true
    },
    {
      "id": "c3d4e5f6-7890-12ab-cdef-345678901abc",
      "name": "Wine Community",
      "slug": "wine-community",
      "member_count": 650,
      "avatar_url": "https://storage.onlydrams.com/communities/avatars/wine-community.png",
      "tier_badge": "Basic",
      "is_member": true
    },
    {
      "id": "d4e5f6a7-8901-23ab-cdef-456789012abc",
      "name": "Bourbon Enthusiasts",
      "slug": "bourbon-enthusiasts",
      "member_count": 1240,
      "avatar_url": "https://storage.onlydrams.com/communities/avatars/bourbon-enthusiasts.png",
      "tier_badge": null,
      "is_member": false
    },
    {
      "id": "e5f6a7b8-9012-34ab-cdef-567890123abc",
      "name": "Scotch Lovers",
      "slug": "scotch-lovers",
      "member_count": 890,
      "avatar_url": null,
      "tier_badge": null,
      "is_member": false
    }
  ]
}
{
  "total": 2,
  "has_more": false,
  "data": [
    {
      "id": "b2c3d4e5-6789-01ab-cdef-234567890abc",
      "name": "RD One",
      "slug": "rd-one",
      "member_count": 650,
      "avatar_url": "https://storage.onlydrams.com/communities/avatars/rd-one.png",
      "tier_badge": "VIP",
      "is_member": true
    },
    {
      "id": "c3d4e5f6-7890-12ab-cdef-345678901abc",
      "name": "Wine Community",
      "slug": "wine-community",
      "member_count": 650,
      "avatar_url": "https://storage.onlydrams.com/communities/avatars/wine-community.png",
      "tier_badge": "Basic",
      "is_member": true
    }
  ]
}
// GET /api/v1/communities/explore?query=bourbon

{
  "total": 1,
  "has_more": false,
  "data": [
    {
      "id": "d4e5f6a7-8901-23ab-cdef-456789012abc",
      "name": "Bourbon Enthusiasts",
      "slug": "bourbon-enthusiasts",
      "member_count": 1240,
      "avatar_url": "https://storage.onlydrams.com/communities/avatars/bourbon-enthusiasts.png",
      "tier_badge": null,
      "is_member": false
    }
  ]
}