Contents
On this page

List Terms - Plugixa Stream

GET /plugixa-stream/v1/admin/terms

Every genre, tag, studio and language, including the ones no title uses yet: the choices of the title editor.

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/terms

Responses

200 OK. data holds one list per taxonomy.

{
  "success": true,
  "data": {
    "genres": [
      {
        "id": 40,
        "name": "Action"
      },
      {
        "id": 35,
        "name": "Animation"
      }
    ],
    "tags": [],
    "studios": [
      {
        "id": 57,
        "name": "Blender Studio"
      }
    ],
    "languages": [
      {
        "id": 58,
        "name": "English"
      }
    ]
  }
}
Field Type Meaning
data.genres object[] id and name of each genre. Same for tags, studios and languages

Errors

Status Code When
401 / 403 plugixa_stream_forbidden The caller lacks the capability.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-stream/v1/admin/terms" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/terms');
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/terms', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share