Contents
On this page

Get Video - Plugixa Video

GET /pvx/v1/videos/{id}

Read one video: the public shape for the watch page, or with context=edit the full shape an editor works with.

Public for published, unlisted and scheduled videos. Drafts, pending and private videos answer 404 unless the caller may edit them. context=edit needs the plugixa_video_view capability and the right to edit this video.

Request

GET https://your-site.example/wp-json/pvx/v1/videos/838

Path parameters

Name Type Description
id integer The video’s id

Query parameters

Name Type Default Description
context string view view for the public shape, edit for the back-office shape.

Responses

200 OK, public shape (context=view).

{
  "success": true,
  "data": {
    "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
  }
}
Field Type Meaning
data.id integer The video’s id
data.title string Plain-text title
data.excerpt string Plain text, up to 30 words. Empty for a password-protected video
data.source string hls, mp4, youtube or vimeo
data.type string video; with Pro also movie or episode
data.poster string Poster image URL, empty when there is none or the video is password-protected
data.duration integer Seconds
data.access string free, members or paid
data.price number Price of a paid video, else 0
data.channel_id integer 0 when the video is in no channel
data.channel string The channel’s name, or empty
data.views integer Times the source was loaded
data.likes integer Likes
data.categories integer[] Category ids
data.date string Publication date, ISO 8601 in UTC
data.status string WordPress status: publish, pvx_unlisted, future, pending, draft or private
data.coming_soon boolean true for a scheduled video
data.poster_srcset string Responsive image sizes of the poster
data.permalink string The video’s page

For a password-protected video the caller may not edit, excerpt and poster are empty. With Pro, series_id, season, episode and, on an episode, heading are added.

200 OK, back-office shape (context=edit).

{
  "success": true,
  "data": {
    "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,
    "description": "<p>A week around Iceland on Route 1.</p>\n<p>00:00 Reykjavik<br>04:10 The Golden Circle<br>12:30 Jokulsarlon</p>",
    "url": "https://cdn.your-site.example/videos/ring-road.mp4",
    "poster_id": 1201,
    "tags": [31, 32],
    "comments": true,
    "release_date": "2026-11-12T10:30",
    "author": 1,
    "modified": "2026-11-12T09:30:00+00:00"
  }
}
Field Type Meaning
data.description string The description as stored, HTML
data.url string The source URL. Only in this back-office shape
data.poster_id integer Media library id of the poster, 0 for none
data.tags integer[] Tag ids
data.comments boolean Whether comments are open
data.release_date string Publication date in the site’s time zone, YYYY-MM-DDTHH:MM
data.author integer The owner’s WordPress user id
data.modified string Last change, ISO 8601 in UTC

With Pro, the back-office shape also carries year, age_rating, cast, trailer, related, captions, password and plays_upload (whether the video plays its own upload), and custom_fields when custom fields are defined for videos.

Errors

Status Code When
404 plugixa_video_not_found No video with that id, or one the caller may not see.
401 / 403 plugixa_video_forbidden context=edit without the plugixa_video_view capability or the right to edit this video.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/pvx/v1/videos/838"

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

Quick Links

Share