Contents
On this page

List POS Users - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/users

Users who hold any Plugixa POS capability, for pickers in the admin app.

Needs a user with the plugixa_pos_view capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators hold it; other roles only when you grant it.

Request

GET https://your-site.example/wp-json/plugixa-pos/v1/users?search=emma

Query parameters

Field Type Required Description
search string No Part of the display name.

Responses

200 OK. data is a list of id and name, at most 50.

{
  "success": true,
  "data": [
    {
      "id": 87,
      "name": "Emma Laurent"
    }
  ]
}

Errors

This endpoint has no errors of its own.

Plus the errors every endpoint can return.

Examples

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

Quick Links

Share