This page describes API endpoints for viewing, editing, and creating Affiliates.
GET /backend/open-api/v1/users/affiliates/{affiliate_id}
Get a list of all affiliates.
Headers
| Name | Value |
|---|---|
| Authorization | Bearer <token> |
Path parameters
| Name | Type | Description | Required |
|---|---|---|---|
affiliate_id |
Integer | ID of an affiliate. | |
| Apply it to view data only about a specific affiliate. |
Query parameters
| Name | Type | Description | Required | Example |
|---|---|---|---|---|
status |
Integer | Filter affiliates by their status: |
0 - Pending
1 - Active
2 - Blocked
3 - Paused | | 2 |
| page | Integer | Defines which page of items is is retrieved. The default values is 1. | | 54 |
| per_page | Integer | Defines the amount of items shown per page( default= 200, Max=500). | | 300 |
| order | String | A property by witch to order by and the sorting order(asc or desc). These two items must be separated with a period. | | name.desc |
Response
{
"data": [
{
"id": 1,
"name": "First test affiliate",
"company": null,
"email": "[email protected]",
"first_name": "test first name",
"last_name": "test",
"birthday": "2023-04-13 20:00",
"phone": "123123",
"skype": "440000",
"telegram": "123123",
"description": "Created by Me at 25/07/22, 2:43 PM",
"otp": true,
"telegram_id": "999999999",
"allow_advertiser_external_id": false,
"password": null,
"confirm_password": null,
"status": 1,
"schema_id": 9,
"only_qualified_postbacks": false,
"affiliate_group_id": 1,
"created_at": "2023-03-22 08:37:26",
"archived": false
},
...
{
"id": 2,
"name": "Affiliate #2",
"company": "",
"email": "[email protected]",
"first_name": "rere",
"last_name": "rere",
"birthday": null,
"phone": "15615",
"skype": "1237777",
"telegram": "1231123",
"description": "Created by Me at 27/09/22, 1:09 PM",
"otp": false,
"telegram_id": null,
"allow_advertiser_external_id": false,
"password": null,
"confirm_password": null,
"status": 3,
"schema_id": 8,
"only_qualified_postbacks": false,
"affiliate_group_id": 1,
"created_at": "2023-07-24 12:44:27",
"archived": true
},
],
"total": 438,
"per_page": 200,
"page": 1,
"pages": 3
}
## Create a new affiliate
`POST` `/backend/open-api/v1/users/affiliates`