Contents
List Roles - Plugixa Extra Product Options
GET /plugixa-epo/v1/lookup/roles
The roles to pick in a group’s targets.roles: guest for visitors who are not signed in, then every role of the site.
Needs a user with the plugixa_epo_manage capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators and shop managers hold it; see Permissions. Pro only: on the free plugin this route answers 404 rest_no_route.
Request
GET https://your-store.example/wp-json/plugixa-epo/v1/lookup/roles
Responses
200 OK.
{
"success": true,
"data": [
{
"id": "guest",
"label": "Guest (not signed in)"
},
{
"id": "administrator",
"label": "Administrator"
},
{
"id": "customer",
"label": "Customer"
},
{
"id": "shop_manager",
"label": "Shop manager"
},
{
"id": "wholesale_customer",
"label": "Wholesale customer"
}
]
}
| Field | Type | Meaning |
|---|---|---|
id |
string |
Role slug, or guest |
label |
string |
Role name, translated |
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_epo_forbidden |
The caller lacks the capability: You are not allowed to do that. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-store.example/wp-json/plugixa-epo/v1/lookup/roles" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-store.example/wp-json/plugixa-epo/v1/lookup/roles');
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-store.example/wp-json/plugixa-epo/v1/lookup/roles', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share