Contents
On this page

Get Series - Plugixa Video

GET /pvx/v1/series/{id}

Read one series with its seasons and episodes, the caller’s progress on each, and the episode to watch next.

Public for a published series. Any other status answers 404 unless the caller may edit the series. Needs Plugixa Video Pro with the Series app on in Plugixa Video -> App manager; with it off, this route answers 404.

Request

GET https://your-site.example/wp-json/pvx/v1/series/910

Path parameters

Name Type Description
id integer The series’ id

Query parameters

Name Type Default Description
context string view edit adds the back-office fields and lists draft, pending and private episodes too, for a caller who may edit this series.

Responses

200 OK. data is the series with its episodes.

{
  "success": true,
  "data": {
    "id": 910,
    "title": "Northern Kitchens",
    "synopsis": "A cook travels north and learns one dish in every town.",
    "poster": "https://your-site.example/wp-content/uploads/2026/11/northern-kitchens-1024x1536.jpg",
    "backdrop": "https://your-site.example/wp-content/uploads/2026/11/northern-kitchens-backdrop.jpg",
    "trailer": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "year": 2026,
    "age_rating": "PG",
    "cast": "Mara Lind\nJonas Berg",
    "categories": [14],
    "permalink": "https://your-site.example/series/northern-kitchens/",
    "status": "publish",
    "seasons": [
      {
        "number": 1,
        "episodes": [
          {
            "id": 912,
            "title": "Tromso: Fish Soup",
            "excerpt": "A week around Iceland on Route 1, from Reykjavik to the glacier lagoons of the south coast.",
            "source": "mp4",
            "type": "episode",
            "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": 1310,
            "access": "free",
            "price": 0.0,
            "channel_id": 0,
            "channel": "",
            "views": 402,
            "likes": 12,
            "categories": [14],
            "permalink": "https://your-site.example/video/tromso-fish-soup/",
            "date": "2026-11-12T09:30:00+00:00",
            "status": "publish",
            "coming_soon": false,
            "series_id": 910,
            "season": 1,
            "episode": 1,
            "heading": "1×1 · Tromso: Fish Soup",
            "progress": {
              "position": 1310,
              "duration": 1310,
              "completed": true
            }
          },
          {
            "id": 913,
            "title": "Alta: Reindeer Stew",
            "excerpt": "A week around Iceland on Route 1, from Reykjavik to the glacier lagoons of the south coast.",
            "source": "mp4",
            "type": "episode",
            "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": 1280,
            "access": "free",
            "price": 0.0,
            "channel_id": 0,
            "channel": "",
            "views": 310,
            "likes": 9,
            "categories": [14],
            "permalink": "https://your-site.example/video/alta-reindeer-stew/",
            "date": "2026-11-12T09:30:00+00:00",
            "status": "publish",
            "coming_soon": false,
            "series_id": 910,
            "season": 1,
            "episode": 2,
            "heading": "1×2 · Alta: Reindeer Stew",
            "progress": null
          }
        ]
      }
    ],
    "next": {
      "id": 913,
      "title": "Alta: Reindeer Stew",
      "excerpt": "A week around Iceland on Route 1, from Reykjavik to the glacier lagoons of the south coast.",
      "source": "mp4",
      "type": "episode",
      "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": 1280,
      "access": "free",
      "price": 0.0,
      "channel_id": 0,
      "channel": "",
      "views": 310,
      "likes": 9,
      "categories": [14],
      "permalink": "https://your-site.example/video/alta-reindeer-stew/",
      "date": "2026-11-12T09:30:00+00:00",
      "status": "publish",
      "coming_soon": false,
      "series_id": 910,
      "season": 1,
      "episode": 2,
      "heading": "1×2 · Alta: Reindeer Stew",
      "progress": null
    },
    "episodes": 2
  }
}
Field Type Meaning
data.id integer The series’ id
data.title string Title
data.synopsis string Plain text
data.poster string Poster image URL, or empty
data.backdrop string Backdrop image URL (full size), or empty
data.trailer string Trailer URL, or empty
data.year integer Release year, 0 when not set
data.age_rating string Free text, up to 20 characters
data.cast string Free text, one name per line by convention
data.categories integer[] Category ids
data.status string publish, pending, draft or private
data.seasons object[] {number, episodes} in season order; episodes in episode order
data.seasons[].episodes[] object Videos in the public shape of List Videos, plus progress
data.seasons[].episodes[].progress object|null The caller’s {position, duration, completed}, null when not started or signed out
data.next object|null The first published episode, or the one after the last finished, or the one in progress. null after the last episode
data.episodes integer Number of episodes listed

Published and scheduled episodes are listed, up to 500. With context=edit, the back-office fields of Create Series are added.

Errors

Status Code When
404 plugixa_video_not_found No series with that id, or one the caller may not see.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/pvx/v1/series/910"

<?php
$ch = curl_init('https://your-site.example/wp-json/pvx/v1/series/910');
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/series/910');
const { data } = await response.json();

Quick Links

Share