Inventory

Get all inventory items

Returns a paginated list of inventory items. Inventory items can be linked to medications (rxs), supplements (plan_other), or general products. Each item tracks stock levels, expiration dates, and is associated with a charge master entry.

All dates are returned in UTC format.

get/inventory

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/inventory
  • Auth: HTTP basic

Query parameters

limitinteger

Maximum number of items to return. Defaults to 100, max is 100.

offsetinteger

Number of items to skip for pagination. Use when has_more is true.

typestring

Filter by inventory type (e.g., "Drug (RX)", "General"). Uses partial matching.

manufacturerstring

Filter by manufacturer name. Uses partial matching.

include_deletedstring

Set to the string 'true' to include soft-deleted items. Other values are ignored.

include_discontinuedstring

Set to the string 'true' to include discontinued items. Other values are ignored.

Response

OK

objectstring
total_countinteger

Number of items returned in this response

has_moreboolean

Whether more items exist beyond the current page

Example response

{
  "object": "list"
}

Changes

No recorded changes to this operation across all 1 revision of this API.