Skip to content

Endpoint

  • Method: GET
  • Path: /referrals/{id}
  • Edition: Core
  • Controller: ReferralController@show
  • Route source: app/Http/Routes/api.php

GET Get Referral

GET
/referrals/{id}

Retrieve a single referral.

Controller: ReferralController@show
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

Path Parameters

id*

The id.

Type
integer
Required

Responses

Successful response

application/json
JSON
{
"referral": {
"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",
"visit": {
},
"payout": {
},
"customer": {
}
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentAffiliate developer documentation