Skip to content

Endpoint

  • Method: GET
  • Path: /affiliates
  • Edition: Core
  • Controller: AffiliateController@index
  • Route source: app/Http/Routes/api.php

GET List Affiliates

GET
/affiliates

List all affiliates with pagination and filters.

Controller: AffiliateController@index
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
15
page

Page number (1-based).

Type
integer
Default
1
search

Search query string.

Type
string
status

Filter by status.

Type
string

Responses

Successful response

application/json
JSON
{
"affiliates": {
"data": [
{
"id": 0,
"user_id": 0,
"status": "string",
"affiliate_code": "string",
"rate": "string",
"rate_type": "string",
"earnings_balance": "string",
"total_paid": "string",
"total_unpaid": "string",
"created_at": "string",
"updated_at": "string"
}
],
"total": 0,
"per_page": 0,
"current_page": 0
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentAffiliate developer documentation