Contents
List Custom Fields - Plugixa Stream
GET /plugixa-stream/v1/admin/custom-fields
Every custom field, in the order the admin arranged them.
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/custom-fields
Responses
200 OK.
{
"success": true,
"data": [
{
"key": "director_cut",
"label": "Director's cut",
"type": "checkbox",
"options": [],
"applies_to": "movie",
"placeholder": "",
"show_in_form": true,
"show_frontend": true,
"filter_admin": true,
"search_admin": false,
"search_frontend": false
}
]
}
| Field | Type | Meaning |
|---|---|---|
data[].key |
string |
Lowercase letter first, then letters, digits or _, up to 40 |
data[].label |
string |
What the editor and viewers see |
data[].type |
string |
text, textarea, number, select, checkbox, date or url |
data[].options |
string[] |
The choices of a select |
data[].applies_to |
string |
all, series or movie |
data[].placeholder |
string |
Hint in the empty input |
data[].show_in_form |
boolean |
Series editor |
data[].show_frontend |
boolean |
Viewer series page |
data[].filter_admin |
boolean |
Admin filters |
data[].search_admin |
boolean |
Admin search |
data[].search_frontend |
boolean |
Viewer search |
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/custom-fields" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/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/custom-fields', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share