List Recipients - Plugixa Inventory

GET /plugixa-inventory/v1/recipients

List recipients, one page at a time, with search, filters and sorting.

The user needs the plugixa_inventory_view capability (administrators have every inventory capability). With Pro Roles and permissions enforcing, their role must also allow reading recipients.

Request

GET https://your-site.example/wp-json/plugixa-inventory/v1/recipients?department__in=Maintenance

Query parameters

Plus the list parameters every paged list accepts. search matches name, email, department, phone. orderby accepts id, name, email, department, status, created_at, modified_at. view=trash lists the trash instead.

The filters this list accepts: status, department, created_at, modified_at.

Responses

200 OK. data is one page of recipients.

{
  "success": true,
  "data": [
    {
      "id": 8,
      "name": "Lucas Bernard",
      "email": "lucas.bernard@example.com",
      "phone": "+44 113 496 0000",
      "department": "Maintenance",
      "user_id": null,
      "notes": "",
      "custom_fields": null,
      "status": "published",
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-12 09:30:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null
    }
  ],
  "meta": {
    "total": 1,
    "pages": 1
  }
}

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-inventory/v1/recipients?department__in=Maintenance" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query(['department__in' => 'Maintenance']);
$ch = curl_init('https://your-site.example/wp-json/plugixa-inventory/v1/recipients?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const query = new URLSearchParams({ department__in: 'Maintenance' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-inventory/v1/recipients?${query}`, {
  headers: { 'Authorization': auth },
});
const { data, meta } = await response.json();