Contents
List Viewers - Plugixa Stream
GET /plugixa-stream/v1/admin/viewers
The Viewers list: accounts with a wallet, most recent activity first; or, with search, any account whose login, email or display name matches.
Needs a user with the plugixa_stream_manage_settings capability (signed in with an Application Password or the login cookie). Administrators hold it; other roles only when you grant it.
Request
GET https://your-site.example/wp-json/plugixa-stream/v1/admin/viewers?search=maya
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
search |
string |
No | Part of a login, email or display name. |
page |
integer |
No | Page to return, from 1. Ignored with search. |
per_page |
integer |
No | Rows, clamped to 1 to 100. Defaults to 24. |
Responses
200 OK.
{
"success": true,
"data": [
{
"id": 7,
"name": "Maya Lindqvist",
"email": "maya@example.com",
"balance": {
"paid": 300,
"bonus": 45,
"total": 345
},
"vip": "2026-12-16 19:03:40"
}
]
}
| Field | Type | Meaning |
|---|---|---|
data[].id |
integer |
The user id |
data[].name |
string |
Display name |
data[].email |
string |
Email address |
data[].balance |
object |
paid, bonus and total coins |
data[].vip |
string|null |
When their VIP period ends, UTC; null when not VIP |
There is no meta.
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_stream_forbidden |
The caller lacks the capability. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-stream/v1/admin/viewers?search=maya" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/viewers?search=maya');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/viewers?search=maya', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share