List unit of measure groups
Operation ID: unitOfMeasureGroups
Group: Inventory › Unit of Measure Groups
Open in the interactive reference
GET /inventory/unit-of-measure-groups
Read-only: Reads and returns; changes nothing.
Lists unit of measure groups. Each group comes back with its name and description, without its base unit or conversion lines.
To get the conversion lines, use GET inventory/unit-of-measure-groups/:id or POST inventory/unit-of-measure-groups/search. To find the groups that convert a given unit of measure, use POST inventory/unit-of-measure-groups/search with filters.unitOfMeasureId.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | string · 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, likename— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between- Orderable: id, name, description, lastModifiedDate
- Selectable: id, name, description, lastModifiedDate
page[size]— Page sizepage[cursor]— Opaque continuation cursor
Response
200 Success
Under data, an array of unitOfMeasureGroupsRow:
| Field | Type | Required | Filter | Sort | Description |
|---|---|---|---|---|---|
id |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The unique identifier for the unit of measure group. Example: "2c7e5a91-6d38-4b04-8f72-1e9c03d5b846". |
name |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The display name of the unit of measure group. Names are not unique. Example: "Packaging". |
description |
string | null | no | no | yes | A free-form description of what the group covers. Example: "Eaches, boxes and pallets". |
lastModifiedDate |
date-time | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the unit of measure group or its conversion lines last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-05-12T09:30:00.000Z". |
{
"data": [
{
"id": "2c7e5a91-6d38-4b04-8f72-1e9c03d5b846",
"name": "Packaging",
"description": "Eaches, boxes and pallets",
"lastModifiedDate": "2026-05-12T09:30:00.000Z"
}
],
"pagination": {
"hasMore": true,
"nextCursor": "<nextCursor>"
}
}
Statuses
400— Invalid request or business failure401— The request carries no valid access token.403— Not authorized404— Not found429— Too many requests from this client address. The response has no body and noRetry-Afterheader.500— Internal server error