List Categories - Plugixa Inventory

GET /plugixa-inventory/v1/categories

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

Request

GET https://your-site.example/wp-json/plugixa-inventory/v1/categories?search=office

Query parameters

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

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

Responses

200 OK. data is one page of categories.

{
  "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
    }
  ],
  "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/categories?search=office" \
  -u "admin:$WP_APP_PASSWORD"

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