Contents
On this page

Get Channel - Plugixa Video

GET /pvx/v1/channels/{id}

Read one channel, with its subscriber count and whether the caller follows it.

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

Note. context=edit is not refused when the caller may not edit the channel: the answer is then simply the public shape.

Request

GET https://your-site.example/wp-json/pvx/v1/channels/692

Path parameters

Name Type Description
id integer The channel’s id

Query parameters

Name Type Default Description
context string view edit returns the back-office shape to a caller who may edit this channel.

Responses

200 OK, public shape.

{
  "success": true,
  "data": {
    "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"
  }
}
Field Type Meaning
data.id integer The channel’s id
data.title string The channel’s name
data.description string Plain text
data.avatar string Avatar image URL (thumbnail size), or empty
data.banner string Banner image URL (full size), or empty
data.links object[] Up to 10 {label, url} links
data.owner string The owner’s display name
data.owner_id integer The owner’s WordPress user id
data.subscribers integer Number of subscribers
data.subscribed boolean Whether the signed-in caller is subscribed. false when signed out
data.status string publish, pending, draft or private

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

{
  "success": true,
  "data": {
    "id": 692,
    "title": "Far Places",
    "description": "<p>Slow travel films from the edges of the map.</p>",
    "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": false,
    "permalink": "https://your-site.example/channel/far-places/",
    "status": "publish",
    "avatar_id": 1301,
    "banner_id": 1302,
    "author": 7
  }
}
Field Type Meaning
data.description string The description as stored, HTML
data.avatar_id integer Media library id of the avatar, 0 for none
data.banner_id integer Media library id of the banner, 0 for none
data.author integer The owner’s WordPress user id

Errors

Status Code When
404 plugixa_video_not_found No channel 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/channels/692"

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

Quick Links

Share