Contents
On this page

List Series - Plugixa Video

GET /pvx/v1/series

List series one page at a time, newest first by default.

Public for published series. context=edit needs the plugixa_video_view capability, and a user who may not edit other people’s series sees only their own. 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?category=14

Query parameters

Name Type Default Description
context string view view for published series in the public shape, edit for every status except the trash in the back-office shape.
category integer Series in this category.

Plus the list parameters every paged list accepts. search matches the title and the synopsis.

Responses

200 OK. data is one page of series.

{
  "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"
    }
  ],
  "meta": {
    "total": 3,
    "pages": 1
  }
}
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
meta.total integer Series matching, before paging
meta.pages integer Number of pages at this per_page

List rows do not include episodes: Get Series adds them.

Errors

Status Code When
401 / 403 plugixa_video_forbidden context=edit without the plugixa_video_view capability.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/pvx/v1/series?category=14"

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

const query = new URLSearchParams({ category: "14" });
const response = await fetch(`https://your-site.example/wp-json/pvx/v1/series?${query}`);
const { data } = await response.json();

Quick Links

Share