Endpoint
- Method:
GET - Path:
/portal/referrals - Edition: Core
- Controller:
PortalController@getReferrals - Route source:
app/Http/Routes/api.php
GET List Portal Referrals
GET
/portal/referrals
Get the authenticated affiliate's referrals.
Controller: PortalController@getReferrals
Route source: app/Http/Routes/api.php
Authorizations
ApplicationPasswords
WordPress Application Passwords — use Basic auth with username:application_password.
Type
API Key (header: Authorization)
Parameters
Query Parameters
per_page
Number of items per page.
Type
integer
Default
15page
Page number (1-based).
Type
integer
Default
1search
Search query string.
Type
string
status
Filter by status.
Type
string
Responses
Successful response
application/json
JSON
{
"referrals": {
"data": [
{
"id": 0,
"affiliate_id": 0,
"visit_id": 0,
"order_id": "string",
"status": "string",
"amount": "string",
"currency": "string",
"provider": "string",
"provider_url": "string",
"created_at": "string",
"updated_at": "string"
}
],
"total": 0,
"per_page": 0,
"current_page": 0
}
}