Contents
On this page

Get Viewer Library - Plugixa Video

GET /pvx/v1/me/library

Read everything the account area shows, in one request: continue watching, history, favorites, subscriptions and playlists.

Any signed-in user (signed in with an Application Password or the login cookie). Signed out, it answers 401. Needs the Viewer library app on in Plugixa Video -> App manager; with it off, this route answers 404.

Request

GET https://your-site.example/wp-json/pvx/v1/me/library

Responses

200 OK. data is the caller’s library.

{
  "success": true,
  "data": {
    "continue": [
      {
        "id": 838,
        "title": "Iceland: The Ring Road",
        "excerpt": "A week around Iceland on Route 1, from Reykjavik to the glacier lagoons of the south coast.",
        "source": "mp4",
        "type": "video",
        "poster": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg",
        "poster_srcset": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg 1024w, https://your-site.example/wp-content/uploads/2026/11/ring-road-300x169.jpg 300w",
        "poster_width": 1024,
        "poster_height": 576,
        "duration": 1460,
        "access": "free",
        "price": 0.0,
        "channel_id": 692,
        "channel": "Far Places",
        "views": 1204,
        "likes": 37,
        "categories": [14],
        "permalink": "https://your-site.example/video/iceland-the-ring-road/",
        "date": "2026-11-12T09:30:00+00:00",
        "status": "publish",
        "coming_soon": false,
        "progress": {
          "position": 412,
          "duration": 1460,
          "completed": false
        }
      }
    ],
    "history": [
      {
        "id": 838,
        "title": "Iceland: The Ring Road",
        "excerpt": "A week around Iceland on Route 1, from Reykjavik to the glacier lagoons of the south coast.",
        "source": "mp4",
        "type": "video",
        "poster": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg",
        "poster_srcset": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg 1024w, https://your-site.example/wp-content/uploads/2026/11/ring-road-300x169.jpg 300w",
        "poster_width": 1024,
        "poster_height": 576,
        "duration": 1460,
        "access": "free",
        "price": 0.0,
        "channel_id": 692,
        "channel": "Far Places",
        "views": 1204,
        "likes": 37,
        "categories": [14],
        "permalink": "https://your-site.example/video/iceland-the-ring-road/",
        "date": "2026-11-12T09:30:00+00:00",
        "status": "publish",
        "coming_soon": false,
        "progress": {
          "position": 412,
          "duration": 1460,
          "completed": false
        }
      }
    ],
    "favorites": [
      {
        "id": 840,
        "title": "Faroe Islands by Ferry",
        "excerpt": "A week around Iceland on Route 1, from Reykjavik to the glacier lagoons of the south coast.",
        "source": "mp4",
        "type": "video",
        "poster": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg",
        "poster_srcset": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg 1024w, https://your-site.example/wp-content/uploads/2026/11/ring-road-300x169.jpg 300w",
        "poster_width": 1024,
        "poster_height": 576,
        "duration": 920,
        "access": "free",
        "price": 0.0,
        "channel_id": 692,
        "channel": "Far Places",
        "views": 880,
        "likes": 21,
        "categories": [14],
        "permalink": "https://your-site.example/video/faroe-islands-by-ferry/",
        "date": "2026-11-10T08:00:00+00:00",
        "status": "publish",
        "coming_soon": false
      }
    ],
    "subscriptions": [
      {
        "id": 692,
        "title": "Far Places",
        "description": "Slow travel films from the edges of the map.",
        "avatar": "https://your-site.example/wp-content/uploads/2026/11/far-places-150x150.jpg",
        "banner": "https://your-site.example/wp-content/uploads/2026/11/far-places-banner.jpg",
        "links": [
          {
            "label": "Instagram",
            "url": "https://instagram.com/farplaces"
          }
        ],
        "owner": "Lena Holt",
        "owner_id": 7,
        "subscribers": 312,
        "subscribed": true,
        "permalink": "https://your-site.example/channel/far-places/",
        "status": "publish"
      }
    ],
    "playlists": [
      {
        "id": 1550,
        "title": "Road trips",
        "description": "Long drives worth watching twice.",
        "visibility": "public",
        "featured": false,
        "owner_id": 25,
        "owner": "Lucas Bernard",
        "count": 2,
        "cover": "https://your-site.example/wp-content/uploads/2026/11/ring-road-1024x576.jpg",
        "modified": "2026-11-12T09:30:00+00:00"
      }
    ],
    "tabs": []
  }
}
Field Type Meaning
data.continue object[] Up to 20 started, unfinished videos, most recent first, each with progress
data.history object[] Up to 50 videos watched, most recent first, each with progress
data.favorites object[] Up to 50 favorite videos, newest first
data.subscriptions object[] Published channels followed, in the shape of Get Channel
data.playlists object[] Up to 100 of the caller’s playlists, in the shape of List Playlists
data.tabs object[] Extra account tabs {id, label, endpoint}. With Pro’s Payments app: purchases and memberships

Videos are in the public shape of List Videos. Videos and channels that are no longer published are left out. None of these lists is paged.

Errors

Status Code When
401 plugixa_video_login_required Signed out.

Plus the errors every endpoint can return.

Examples

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

Quick Links

Share