Get Category - Plugixa Inventory for WordPress

Get Category - Plugixa Inventory

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

Read one category.

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 categories.

Request

GET https://your-site.example/wp-json/plugixa-inventory/v1/categories/3

Path parameters

Name	Type	Description
`id`	`integer`	The category’s id

Responses

`200` OK. `data` is the category.

{
  "success": true,
  "data": {
    "id": 3,
    "code": "OFFICE",
    "name": "Office supplies",
    "description": "<p>Paper, toner and desk items.</p>",
    "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 category’s id
`data.code`	`string`	Upper-case code, or empty
`data.name`	`string`	The name
`data.description`	`string\|null`	HTML
`data.status`	`string`	`published` or `unpublished`
`data.created_at`	`string`	UTC datetime
`data.deleted_at`	`string\|null`	`null` unless the category is in the trash

Errors

Status	Code	When
`404`	`plugixa_inventory_not_found`	No category 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/categories/3" \
  -u "admin:$WP_APP_PASSWORD"

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