Returns a list of item categories.

GET /inventory/item-categories

Group: Inventory › Item Categories · Operation ID: itemCategories

The item category collection. Every field is scalar, so each row contains the same schema as GET inventory/item-categories/:id: nothing is withheld here.

parentId is returned but is not filterable or orderable. To read the tree, use GET inventory/item-categories/tree, which returns every category with its parent, its ancestor path and its depth. Filtering by a category elsewhere in this API, such as the item collection or the aging and turnover reports, rolls up: it means that category or any category beneath it.

Names are not unique, so a name filter can return several rows. There is no free-text or substring matching on any endpoint here.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
name — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
active — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, name, description, active, idealTurnoverRatio, lastModifiedDate
Selectable: id, name, description, active, idealTurnoverRatio, lastModifiedDate

Response

200 Success

Under data, an array of itemCategoriesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the item category.
`name`	string	no	The display name of the category, for example 'Hardware'. Not unique: two categories can share a name, so use id to address one.
`description`	string or null	no	A free-form description of what the category covers. Absent when none was set.
`active`	boolean or null	no	Whether the category can be chosen on new items. When false the category is retired: existing items keep it and new ones cannot be assigned to it.
`idealTurnoverRatio`	string (decimal) or null	no	The target inventory turnover for items in this category, in times per year. For analytics only. A ratio rather than an amount, so it has no currency.
`lastModifiedDate`	string (date-time) or null	no	The date and time the category last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error