Referência de APIReferrals
List all referrals
Retrieve a paginated list of all referrals.
Retrieve a paginated list of all referrals.
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication. Use your API key as the bearer token.
In: header
Query Parameters
page?integer
Default
1per_page?integer
Default
20member_id?string
Filter by referrer member ID
status?string
Filter by status
Value in
"pending" | "approved" | "rejected" | "cancelled"created_after?string
Filter by creation date (ISO 8601)
Format
datecreated_before?string
Filter by creation date (ISO 8601)
Format
dateResponse Body
application/json
application/json
curl -X GET "https://api-base.rafo.work/api/v1/referrals"{
"data": [
{
"id": "ref_xxxxx",
"member_id": "string",
"member": {
"id": "string",
"name": "string",
"email": "string"
},
"referee_email": "string",
"referee_name": "string",
"referee_external_id": "string",
"order_id": "string",
"order_value": 0,
"reward_amount": 0,
"status": "pending",
"rejection_reason": "string",
"warranty_expires_at": "2019-08-24T14:15:22Z",
"source": "guru",
"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"
}
}