Contents
On this page

List Profiles - Plugixa Stream

GET /plugixa-stream/v1/me/profiles

The caller’s profiles and which one this login session is on. Each profile keeps its own progress, My List, likes and reviews; coins, unlocks and VIP belong to the account.

Any signed-in user (an Application Password, or the login cookie with an X-WP-Nonce header). Signed out, it answers 401 plugixa_stream_login_required. It always acts on the caller’s own account.

Note. Requests signed with an Application Password have no login session, so they always act as the account’s own profile.

Request

GET https://your-site.example/wp-json/plugixa-stream/v1/me/profiles

Responses

200 OK.

{
  "success": true,
  "data": {
    "profiles": [
      {
        "id": 0,
        "name": "Maya",
        "avatar": 0,
        "kids": false,
        "main": true
      },
      {
        "id": 1,
        "name": "Leo",
        "avatar": 3,
        "kids": true,
        "main": false
      }
    ],
    "active": 0,
    "kids": false,
    "has_pin": true,
    "max": 5,
    "can_add": true,
    "avatars": 8
  }
}
Field Type Meaning
data.profiles[] object The account’s own profile first (id 0, main true), then the others: id (1 to 9), name, avatar (0 to 7), kids
data.active integer The profile this login session is on
data.kids boolean The session is on a kids profile
data.has_pin boolean A PIN guards leaving a kids profile
data.max integer Profiles an account may have, its own included (the profiles_max setting, 1 to 5)
data.can_add boolean Another profile can be added from here
data.avatars integer How many avatar pictures there are

Errors

Status Code When
401 plugixa_stream_login_required Signed out.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-stream/v1/me/profiles" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/me/profiles');
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/me/profiles', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share