WOworkiz
Items

Retrieve an item

Changed on

Beta: Breaking changes may occur without notice.

Retrieves a single item by its ID.

get/v2/items/{id}

Request

Path parameters

idstring required
Example:ITM-4a7d0e91c3b85f26

The item ID (prefix ITM-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

The requested item.

idstring

The ID of the item (prefix ITM-).

serialIdnumber

The serial ID of the item.

namestring

The name of the item.

descriptionstring

The description of the item.

modelstring

The model number of the item.

inventoryManagedboolean

Whether the inventory of the item is managed.

currentStocknumber

The current stock of the item.

costnumber

The cost of the item.

pricenumber

The price of the item.

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

The type of the item.

taxableboolean

Whether the item is taxable.

discountableboolean

Whether a discount can be applied to the item.

bookingboolean

Whether the item is available in online booking.

bookingPricenumber nullable

The online booking price of the item.

activeboolean

Whether the item is active.

imageUrlstring nullable

The image URL of the item.

updatedstring nullable

The date and time when the item was last updated.

Example response

{
  "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",
  "customFields": [
    {
      "id": "ICF-63f1a0c8be24d975",
      "name": "Warranty length",
      "value": "12 months"
    }
  ]
}

Changes