> ## Documentation Index > Fetch the complete documentation index at: https://docs.decodahealth.com/llms.txt > Use this file to discover all available pages before exploring further. # List Packages > List packages with optional filtering and patient counts. ## OpenAPI ````yaml get /inventory/packages/list openapi: 3.1.0 info: title: Decoda API description: External API documentation for the Decoda Health platform. version: '1.0' servers: [] security: [] paths: /inventory/packages/list: get: tags: - provider - inventory summary: List Packages description: List packages with optional filtering and patient counts. operationId: list_packages_inventory_packages_list_get parameters: - name: TENANT in: header required: true schema: type: string title: Tenant description: The tenant you are making this request on behalf of - name: API-KEY in: header required: true schema: type: string title: Api-Key description: Your api key - name: page in: query required: false schema: anyOf: - type: integer - type: 'null' title: Page - name: per_page in: query required: false schema: anyOf: - type: integer - type: 'null' title: Per Page - name: sort_by in: query required: false schema: anyOf: - type: string - type: 'null' title: Sort By - name: sort_direction in: query required: false schema: anyOf: - type: string enum: - asc - desc - type: 'null' title: Sort Direction - name: location_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Location Id - name: ids in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: List of package IDs to filter by title: Ids description: List of package IDs to filter by - name: name in: query required: false schema: anyOf: - type: string - type: 'null' description: Name of the package title: Name description: Name of the package - name: price in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' description: Price range [min, max] in cents title: Price description: Price range [min, max] in cents - name: contains_items in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: Filter by item names contained in package title: Contains Items description: Filter by item names contained in package - name: number_of_active_patients in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' description: Filter by range of number of active patients [min, max] title: Number Of Active Patients description: Filter by range of number of active patients [min, max] - name: category in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by category name (references category.name) title: Category description: Filter by category name (references category.name) responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Page_PackageDetail_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: Page_PackageDetail_: properties: data: items: $ref: '#/components/schemas/PackageDetail' type: array title: Data total: type: integer title: Total type: object required: - data - total title: Page[PackageDetail] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError PackageDetail: properties: id: type: string title: Id description: Unique identifier for the package name: type: string title: Name description: Name of the package description: anyOf: - type: string - type: 'null' title: Description description: Optional description of the package isArchived: type: boolean title: Isarchived description: Whether the package is archived default: false price: type: integer title: Price description: Price of the package in cents internalNotes: anyOf: - type: string - type: 'null' title: Internalnotes description: Optional internal notes for the package items: anyOf: - items: $ref: '#/components/schemas/PackageItem-Output' type: array - type: 'null' title: Items description: Items included in the package category: anyOf: - type: string - type: 'null' title: Category description: Category name (references category.name) numberOfActivePatients: type: integer title: Numberofactivepatients description: Number of active patients on this package default: 0 numberOfPatients: type: integer title: Numberofpatients description: Total number of patients who have purchased this package default: 0 createdDate: anyOf: - type: string format: date-time - type: 'null' title: Createddate description: Date the package was created type: object required: - name - price title: PackageDetail ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError PackageItem-Output: properties: id: type: string title: Id description: Unique identifier for the package item packageId: type: string title: Packageid description: Package ID this item belongs to itemId: type: string title: Itemid description: Item ID for this package item quantity: anyOf: - type: integer - type: 'null' title: Quantity description: Quantity of the item in the package price: type: integer title: Price description: Price of the item in the package in cents item: anyOf: - $ref: '#/components/schemas/ItemTiny' - type: 'null' description: Details of the item type: object required: - packageId - itemId - price title: PackageItem ItemTiny: properties: id: type: string title: Id description: Unique identifier for the item name: type: string title: Name description: Name of the item brandName: anyOf: - type: string - type: 'null' title: Brandname description: Optional brand name of the item description: anyOf: - type: string - type: 'null' title: Description description: Optional description of the item price: type: integer title: Price description: Price of the item in cents category: anyOf: - type: string - type: 'null' title: Category description: Category name (references category.name) unit: anyOf: - $ref: '#/components/schemas/Unit' - type: 'null' description: Unit of measurement for the item isPhysical: type: boolean title: Isphysical description: Whether the item is physical default: true isArchived: type: boolean title: Isarchived description: Whether the item is archived default: false internalNotes: anyOf: - type: string - type: 'null' title: Internalnotes description: Optional internal notes for the item taxable: type: boolean title: Taxable description: Whether the item is subject to taxes default: false sortOrder: anyOf: - type: integer - type: 'null' title: Sortorder description: Optional sort order for the item allowCustomPricing: type: boolean title: Allowcustompricing description: Whether custom pricing is allowed for this item default: false type: $ref: '#/components/schemas/ItemType' description: Type of item (PRODUCT, MEDICATION, etc.) default: PRODUCT type: object required: - name - price title: ItemTiny Unit: type: string enum: - AMPOULES - APPLICATORS - BOTTLES - BOXES - CAPSULES - CUPS - DOSES - G_PER_ML - GRAMS - IU - IU_PER_ML - OUNCES - FLUID_OUNCES - KG - KITS - LITERS - MCG - MG - MG_PER_ML - ML - MMOL - MICROGRAM_PER_ML - PACKS - PAIRS - PATCHES - PERCENTAGE - PIECES - POUCHES - ROLLS - SACHETS - SHEETS - SPRAYS - STRIPS - SYRINGES - TABLETS - TABLETS_PER_DAY - TESTS - TUBES - UNITS - VIALS - TREATMENTS - SESSIONS - PULSES - JOULES - CENTIMETERS - THREAD_COUNT - INJECTIONS - WRINKLE_UNITS - POUNDS - FEET - INCHES title: Unit ItemType: type: string enum: - ITEM - PRODUCT - MEDICATION - SERVICE - PACKAGE - MEMBERSHIP title: ItemType ````