Contents
On this page

Get Playlist - Plugixa Video

GET /pvx/v1/playlists/{id}

Read one playlist with its videos in order.

Public for public and unlisted playlists. A private playlist answers 404 to everyone except its owner and users who may edit other people’s videos. Needs the Playlists app on in Plugixa Video -> App manager; with it off, this route answers 404.

Note. count includes videos that are no longer published, while videos leaves them out for anyone who does not manage the playlist.

Request

GET https://your-site.example/wp-json/pvx/v1/playlists/1550

Path parameters

Name Type Description
id integer The playlist’s id

Responses

200 OK. data is the playlist with its videos.

{
  "success": true,
  "data": {
    "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",
    "videos": [
      {
        "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
      },
      {
        "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
      }
    ],
    "can_manage": true
  }
}
Field Type Meaning
data.id integer The playlist’s id
data.title string Name
data.description string Plain text
data.visibility string public, unlisted or private
data.featured boolean Marked by an editor for featured lists
data.owner_id integer The owner’s WordPress user id
data.owner string The owner’s display name
data.count integer Number of videos in the playlist, unpublished ones included
data.cover string The poster of one of the first five videos, or empty
data.modified string Last change, ISO 8601 in UTC
data.videos object[] The videos in playlist order, public shape. Up to 500
data.can_manage boolean Whether the caller may change it

Errors

Status Code When
404 plugixa_video_not_found No playlist with that id, or a private playlist the caller may not see.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/pvx/v1/playlists/1550"

<?php
$ch = curl_init('https://your-site.example/wp-json/pvx/v1/playlists/1550');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/pvx/v1/playlists/1550');
const { data } = await response.json();

Quick Links

Share