Referência de APIMembers
List all members
Retrieve a paginated list of all members in your referral program.
Retrieve a paginated list of all members in your referral program.
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication. Use your API key as the bearer token.
In: header
Query Parameters
page?integer
Page number
Default
1per_page?integer
Items per page
Default
20Range
value <= 100status?string
Filter by member status
Value in
"active" | "inactive" | "blocked"campaign_id?string
Filter by campaign ID
search?string
Search by name or email
Response Body
application/json
application/json
curl -X GET "https://api-base.rafo.work/api/v1/members"{
"data": [
{
"id": "mem_xxxxx",
"email": "john@example.com",
"name": "John Doe",
"external_id": "cust_123",
"coupon_code": "NUT-JOHN-A7X",
"campaign_id": "camp_xxxxx",
"status": "active",
"wallet": {
"pending": 0,
"available": 0,
"currency": "BRL"
},
"stats": {
"total_referrals": 0,
"total_earnings": 0
},
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"page": 0,
"per_page": 0,
"total": 0,
"total_pages": 0
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}