---
title: "List Items"
method: GET
path: "/items"
tags: ["items"]
---

# List Items

`GET /items`

## Request

- Base URL: `https://app.zenventory.com/rest`
- URL: `https://app.zenventory.com/rest/items`
- Auth: none declared

Get a list of items based on search parameters.

## Query parameters

- `searchFor` string
- `clientId` integer
- `clientName` string
- `category` string
- `active` boolean
- `createdFrom` string, date-time
- `createdTo` string, date-time
- `modifiedFrom` string, date-time
- `modifiedTo` string, date-time
- `nonInventory` boolean
- `includeUnits` boolean
- `includeBom` boolean
- `includeImage` boolean
- `encodeImage` boolean
- `orderBy` '' | 'id' | 'sku' | 'upc' | 'category' | 'unitCost' | 'price' | 'userField1' | 'userField2' | 'userField3' | 'userField4' | 'userField5' | 'userField6'
- `orderDir` 'asc' | 'desc'
- `page` integer
- `perPage` integer

## Response `200`

Success

- ItemList
  - `items` ItemWithAdditional[]
    - `id` integer
    - `sku` string
    - `upc` string
    - `description` string
    - `category` string
    - `client` ClientCompact
      - `id` integer
      - `name` string
    - `baseUom` string
    - `unitCost` number
    - `leadTime` integer
    - `defaultEconOrder` integer
    - `rrp` number
    - `price` number
    - `active` boolean
    - `kit` boolean
    - `assembly` boolean
    - `perishable` boolean
    - `trackLot` boolean
    - `serialized` boolean
    - `nonInventory` boolean
    - `weight` number
    - `storageLength` number
    - `storageWidth` number
    - `storageHeight` number
    - `storageVolume` number
    - `safetyStock` integer
    - `userField1` string
    - `userField2` string
    - `userField3` string
    - `userField4` string
    - `userField5` string
    - `userField6` string, date-time
    - `createdDate` string, date-time
    - `modifiedDate` string, date-time
    - `notes` string
    - `additionalFields` ItemAdditionalFields
      - `units` object[]
        - `name` string
        - `quantity` integer
      - `assemblyBom` object[]
        - `id` integer
        - `sku` string
        - `uom` string
        - `quantity` integer
      - `kitBom` object[]
        - `id` integer
        - `sku` string
        - `uom` string
        - `quantity` integer
      - `image` string
  - `meta` PaginationMeta
    - `count` integer: Total number of objects in the result set.
    - `page` integer: The page of the result set in the response.
    - `perPage` integer: Number of objects per page.
    - `totalPages` integer: Total number of pages in the result set.

---

[API](https://skmtc.dev/zenventory/apis/zenventory-rest-api.md) · [All operations](https://skmtc.dev/zenventory/apis/zenventory-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zenventory/apis/zenventory-rest-api/revisions/b40aa340773b?raw)