provider
inventory
List Packages
List packages with optional filtering and patient counts.
get/inventory/packages/list
Query parameters
pageinteger nullable
per_pageinteger nullable
sort_bystring nullable
sort_direction'asc' | 'desc' nullable
location_idstring nullable
idsstring[] nullable
List of package IDs to filter by
List of package IDs to filter by
namestring nullable
Name of the package
Name of the package
priceinteger[] nullable
Price range [min, max] in cents
Price range [min, max] in cents
contains_itemsstring[] nullable
Filter by item names contained in package
Filter by item names contained in package
number_of_active_patientsinteger[] nullable
Filter by range of number of active patients [min, max]
Filter by range of number of active patients [min, max]
categorystring nullable
Filter by category name (references category.name)
Filter by category name (references category.name)
Headers
TENANTstring required
The tenant you are making this request on behalf of
API-KEYstring required
Your api key
Response
Successful Response
Changes
No recorded changes to this endpoint across all 1 revision of this API.