GET
/
api
/
items
{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "id": 1,
      "name": "Ergonomic Office Chair Model X-2000",
      "type": "inventory",
      "typeFormatted": "Inventory Item",
      "code": "CHAIR-X2000",
      "sellable": true,
      "purchasable": true,
      "sellPrice": 399.99,
      "sellPriceFormatted": "$399.99",
      "costPrice": 299.99,
      "costPriceFormatted": "$299.99",
      "currencyCode": "USD",
      "costAccountId": 1001,
      "costAccount": {},
      "inventoryAccountId": 3001,
      "inventoryAccount": {},
      "sellAccountId": 2001,
      "sellAccount": {},
      "categoryId": 5,
      "category": {},
      "sellDescription": "Premium ergonomic office chair with adjustable height and lumbar support",
      "purchaseDescription": "Ergonomic office chair - Model X-2000 with standard features",
      "quantityOnHand": 50,
      "note": "Available in black, gray, and navy colors. 5-year warranty included.",
      "active": true,
      "sellTaxRateId": 1,
      "sellTaxRate": {},
      "purchaseTaxRateId": 1,
      "purchaseTaxRate": {},
      "itemWarehouses": [
        "<any>"
      ],
      "createdAt": "2024-03-20T10:00:00Z",
      "updatedAt": "2024-03-20T10:00:00Z"
    }
  ]
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Query Parameters

​
inactiveMode
boolean

Filter for inactive items

​
pageSize
number

Number of items per page

​
page
number

Page number for pagination

​
viewSlug
string

View slug for filtering

​
searchKeyword
string

Search keyword

​
stringifiedFilterRoles
string

Stringified filter roles

​
sortOrder
enum<string>

Sort order direction

Available options:
DESC,
ASC
​
columnSortBy
string

Column sort direction

​
filterRoles
string[]

Array of filter roles

​
customViewId
number

Custom view ID for filtering

Response

200 - application/json

The item list has been successfully retrieved.

The response is of type object.