Contents
On this page

List Channels - Plugixa Video

GET /pvx/v1/channels

List channels one page at a time, sorted by name.

Public for published channels. context=edit needs the plugixa_video_view capability, and a user who may not edit other people’s channels sees only their own. Needs the Channels app on in Plugixa Video -> App manager; with it off, this route answers 404.

Note. Channels always come back sorted by name, A to Z: order has no effect here.

Request

GET https://your-site.example/wp-json/pvx/v1/channels?search=places

Query parameters

Name Type Default Description
context string view view for published channels in the public shape, edit for every status except the trash in the back-office shape.

Plus the list parameters every paged list accepts. search matches the name and the description.

Responses

200 OK. data is one page of channels.

{
  "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": false,
      "permalink": "https://your-site.example/channel/far-places/",
      "status": "publish"
    }
  ],
  "meta": {
    "total": 1,
    "pages": 1
  }
}
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
meta.total integer Channels matching, before paging
meta.pages integer Number of pages at this per_page

With context=edit, each row is the back-office shape of Get Channel.

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/channels?search=places"

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

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

Quick Links

Share