WOworkiz
Item Categories

Retrieve a list of item categories

Changed on

Beta: Breaking changes may occur without notice.

Retrieves a paginated list of the item categories of the account.

Categories are a tree: a top level category has a null parentId, and parentId can be used to list the direct children of a category.

Use the returned category ID with the categoryId filter on the items endpoint to list the items of a category.

get/v2/itemCategories

Request

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

fieldstring
Example:name

The field to sort by. Allowed values: name, created, updated. Must be combined with order.

orderstring
Example:ASC

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

parentIdstring
Example:ITC-2f5a8c0b6d1e9437

Filter item categories by their parent category ID (prefix ITC-).

activeboolean
Example:true

Filter item categories by whether they are active.

datePropertystring
Example:updated

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

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 item categories.

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": "ITC-9b2c1d4e7f0a3b56",
      "name": "Plumbing",
      "description": "Pipes, fittings and plumbing fixtures.",
      "parentId": "ITC-2f5a8c0b6d1e9437",
      "active": true,
      "updated": "2026-01-01 10:00:00",
      "created": "2026-01-01 10:00:00"
    }
  ]
}

Changes