Contents
On this page

Get Recipient - Plugixa Inventory

GET /plugixa-inventory/v1/recipients/{id}

Read one recipient.

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

Path parameters

Name Type Description
id integer The recipient’s id

Responses

200 OK. data is the recipient.

{
  "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
  }
}
Field Type Meaning
data.id integer The recipient’s id
data.name string The name
data.email string E-mail address, or empty
data.department string Department, or empty
data.user_id integer|null The linked WordPress user, or null
data.custom_fields object|null The Pro custom field values, when defined
data.status string published or unpublished
data.deleted_at string|null null unless the recipient is in the trash

Errors

Status Code When
404 plugixa_inventory_not_found No recipient with that id, or it is in the trash.

Plus the errors every endpoint can return.

Examples

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

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-inventory/v1/recipients/8');
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 response = await fetch('https://your-site.example/wp-json/plugixa-inventory/v1/recipients/8', {
  headers: { 'Authorization': auth },
});
const { data } = await response.json();

Quick Links

Share