Get Package

Get a specific package by ID.

get/inventory/packages/{package_id}

Path parameters

package_idstring required

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Successful Response

idstring

Unique identifier for the package

namestring required

Name of the package

descriptionstring nullable

Optional description of the package

isArchivedboolean

Whether the package is archived

priceinteger required

Price of the package in cents

internalNotesstring nullable

Optional internal notes for the package

categorystring nullable

Category name (references category.name)

numberOfActivePatientsinteger

Number of active patients on this package

numberOfPatientsinteger

Total number of patients who have purchased this package

createdDatestring date-time nullable

Date the package was created

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