Skip to main content
GET
/
inventory
/
packages
/
list
List Packages
curl --request GET \
  --url https://api.decodahealth.com/inventory/packages/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "name": "<string>",
      "price": 123,
      "id": "<string>",
      "description": "<string>",
      "isArchived": false,
      "internalNotes": "<string>",
      "items": [
        {
          "packageId": "<string>",
          "itemId": "<string>",
          "price": 123,
          "id": "<string>",
          "quantity": 123,
          "item": {
            "name": "<string>",
            "price": 123,
            "id": "<string>",
            "brandName": "<string>",
            "description": "<string>",
            "category": "<string>",
            "unit": "AMPOULES",
            "isPhysical": true,
            "isArchived": false,
            "internalNotes": "<string>",
            "taxable": false,
            "sortOrder": 123,
            "allowCustomPricing": false,
            "type": "PRODUCT"
          }
        }
      ],
      "category": "<string>",
      "numberOfActivePatients": 0,
      "numberOfPatients": 0,
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

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