Skip to content

Endpoint

  • Method: GET
  • Path: /settings/groups
  • Edition: PRO
  • Controller: AffiliateGroupController@index
  • Route source: fluent-affiliate-pro/app/Http/Routes/api.php

GET List Groups

GET
/settings/groups

List all affiliate groups.

Controller: AffiliateGroupController@index
Route source: fluent-affiliate-pro/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
{
"groups": {
"data": [
{
"id": 0,
"name": "string",
"description": "string",
"status": "string",
"affiliates_count": 0,
"visits_count": 0,
"total_earnings": "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