WOworkiz
Items

Retrieve a list of items

Changed on

Beta: Breaking changes may occur without notice.

Retrieves a paginated list of the price book and inventory items of the account.

Use categoryId to list the items of a single category, serialId to fetch a specific set of items, and type, active, inventoryManaged and booking to narrow the list further. Category IDs come from the item categories endpoints.

Results are ordered by serialId descending - newest first - unless field and order are given.

get/v2/items

Request

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

fieldstring
Example:serialId

The field to sort by. Allowed values: serialId, name, price, cost, updated. Must be combined with order. Defaults to serialId descending.

orderstring
Example:DESC

The sort direction. Allowed values: ASC, DESC. Must be combined with field.

serialIdstring
Example:1042,1043

Filter items by serial ID. Accepts a comma separated list of up to 300 values.

categoryIdstring
Example:ITC-9b2c1d4e7f0a3b56

Filter items by category ID (prefix ITC-).

type'service' | 'product' | 'hours' | 'expense' | 'equipment' | 'warranty'

Filter items by type.

activeboolean
Example:true

Filter items by whether they are active.

inventoryManagedboolean
Example:true

Filter items by whether their inventory is managed.

bookingboolean
Example:true

Filter items by whether they are available in online booking.

datePropertystring
Example:updated

The date property to filter by. Allowed values: updated.

dateOperatorstring
Example:between

The date comparison to apply. Allowed values: prev, next, between.

datestring
Example:2026-01-01_2026-01-31

The date to filter by, as YYYY-MM-DD, or YYYY-MM-DD_YYYY-MM-DD for the between operator.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A paginated list of items.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "ITM-4a7d0e91c3b85f26",
      "serialId": 1042,
      "name": "Water heater",
      "description": "50 gallon gas water heater.",
      "model": "GW-50-NG",
      "category": {
        "id": "ITC-9b2c1d4e7f0a3b56",
        "name": "Plumbing"
      },
      "inventoryManaged": true,
      "currentStock": 12,
      "cost": 210.5,
      "price": 399.99,
      "type": "product",
      "taxable": true,
      "discountable": true,
      "bookingPrice": 449.99,
      "active": true,
      "imageUrl": "https://example.com/image.png",
      "updated": "2026-01-01 10:00:00"
    }
  ]
}

Changes