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.

​
URL Parameters

​
community_id
integer
required
The ID of the community

​
Query Parameters

​
status
string
Filter by membership status - active, canceled, past_due, unpaid, trialing, incomplete
​
tier_id
integer
Filter by membership tier ID
​
search
string
Search by user email, username, first name, or last name
​
page
number
Page number (default: 1)
​
per_page
number
Results per page (default: 20)

​
Returns

Returns a paginated list of community membership objects. 
curl -X GET https://api.onlydrams.app/odis/v1/communities/1/members \
     -H "Authorization: Bearer $ACCESS_TOKEN" \
     -G \
     -d "status=active" \
     -d "tier_id=1" \
     -d "page=1" \
     -d "per_page=20"

{
  "count": 127,
  "results": [
    {
      "id": 50,
      "status": "active",
      "current_period_start": "2024-11-01T00:00:00Z",
      "current_period_end": "2024-12-01T00:00:00Z",
      "trial_start": null,
      "trial_end": null,
      "canceled_at": null,
      "ended_at": null,
      "shipping_address": {
        "name": "John Doe",
        "line1": "123 Main St",
        "city": "Portland",
        "state": "OR",
        "postal_code": "97201",
        "country": "US"
      },
      "metadata": {},
      "is_blocked": false,
      "block_reason": null,
      "total_refunded": 0,
      "lifetime_spend_cents": 2997,
      "requires_shipping_address": true,
      "has_shipping_address": true,
      "user": {
        "id": 200,
        "username": "whisky_lover",
        "email": "member@example.com",
        "first_name": "John",
        "last_name": "Doe"
      },
      "membership_tier": {
        "id": 1,
        "name": "Bronze Member",
        "monthly_price_dollars": 9.99
      },
      "community": {
        "id": 1,
        "name": "Whisky Enthusiasts"
      },
      "created_at": "2024-08-15T10:30:00Z",
      "updated_at": "2024-11-14T08:20:00Z"
    }
  ]
}

​
Response Fields

​
count
integer
Total number of members matching the filter criteria
​
results
array
Array of community membership objects for the current page

​
Notes

  • Authorization: Community owner or admin only
  • Search: Searches across user email, username, first name, and last name
  • Filtering: Multiple filters can be combined