Contents
On this page

Get Custom Field Values - Plugixa Stream

GET /plugixa-stream/v1/admin/series/{id}/custom-fields

A title’s custom field values, for the fields that apply to its kind.

Needs a user with the plugixa_stream_view capability (signed in with an Application Password or the login cookie). Administrators hold it; other roles only when you grant it.

Request

GET https://your-site.example/wp-json/plugixa-stream/v1/admin/series/2681/custom-fields

Path parameters

Name Type Description
id integer The title’s id

Responses

200 OK. data maps field keys to values.

{
  "success": true,
  "data": {
    "director_cut": true,
    "festival": "Netherlands Film Festival 2010"
  }
}

Values are strings, '' when not set; a checkbox is a boolean. Viewers see the fields with Viewer series page on in Get Title.

Errors

Status Code When
401 / 403 plugixa_stream_forbidden The caller lacks the capability.
404 plugixa_stream_not_found No title with that id.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-stream/v1/admin/series/2681/custom-fields" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/series/2681/custom-fields');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/series/2681/custom-fields', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share