Skip to main content
GET
List Packages

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
ids
string[] | null

List of package IDs to filter by

name
string | null

Name of the package

price
integer[] | null

Price range [min, max] in cents

contains_items
string[] | null

Filter by item names contained in package

number_of_active_patients
integer[] | null

Filter by range of number of active patients [min, max]

category
string | null

Filter by category name (references category.name)

Response

Successful Response

data
PackageDetail · object[]
required
total
integer
required