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.
Authentication
This endpoint requires authentication. The authenticated user must be the community owner or an admin.
Path Parameters
The unique identifier of the community
Query Parameters
Filter payouts by status. Use all or omit to show all payouts.Possible values: pending, processing, paid, failed, all
Page number for pagination
Number of results per page
Response
Total number of payout records
Whether there are more results available
Array of payout objects
Unique identifier for the payout record
Total amount before platform fees
Platform fee deducted from the gross amount
Final amount paid out (gross_amount - platform_fee)
Currency code (e.g., “usd”)
Current status of the payout: completed, pending, processing, or failed
Error message if the payout failed
curl -H "Authorization: $ACCESS_TOKEN" \
--request GET \
--url https://api.onlydrams.app/api/v1/communities/:community_id/payouts/history
{
"total": 2,
"has_more": false,
"data": [
{
"id": "6f408933-fc27-4821-b77c-ffc91ccc5d65",
"gross_amount": "4.13",
"platform_fee": "0.0",
"net_amount": "4.13",
"currency": "usd",
"status": "completed",
"error_message": null
},
{
"id": "d0ed3fdb-e066-4d4e-81a3-f4428722a2c2",
"gross_amount": "4.13",
"platform_fee": "0.0",
"net_amount": "4.13",
"currency": "usd",
"status": "completed",
"error_message": null
}
]
}
