---
search:
  tags:
    - Reports
    - GET
seo:
  description: >-
    Admin, branch manager, or auditor. Returns totals, value, categories, and a…
    Reference for the GET /api/v1/reports/inventory endpoint in the PharmaFlow
    API.
sidebar:
  label: Report on the medicine inventory
  badge: GET
title: Report on the medicine inventory
type: openapi-operation
---
Admin, branch manager, or auditor. Returns totals, value, categories, and a low stock list. A branch_id scopes every figure to that branch; without one the org-wide stock is reported.

`GET /api/v1/reports/inventory`

**Responses**

- `200` — The inventory report
- `401` — Not authenticated
- `403` — Caller is not an admin, branch manager, or auditor

Response example, 200:

```json
{
  "total_medicines": -9007199254740991,
  "low_stock_count": -9007199254740991,
  "inventory_value": "string",
  "by_category": [
    {
      "category": "string",
      "medicine_count": -9007199254740991,
      "total_units": -9007199254740991,
      "total_value": "string"
    }
  ],
  "low_stock_list": [
    {
      "id": "string",
      "name": "string",
      "category": "string",
      "stock_quantity": -9007199254740991,
      "low_stock_threshold": -9007199254740991,
      "selling_price": "string"
    }
  ]
}
```