List units of measure
Operation ID: unitOfMeasures
Group: Inventory › Units of Measure
Open in the interactive reference
GET /inventory/unit-of-measures
Read-only: Reads and returns; changes nothing.
Lists units of measure. The response gives each unit of measure's code and display name. The fields are the same as on GET inventory/unit-of-measures/:id and POST inventory/unit-of-measures/search.
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, likeunitCode— 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, unitCode, unitName, lastModifiedDate
- Selectable: id, unitCode, unitName, lastModifiedDate
page[size]— Page sizepage[cursor]— Opaque continuation cursor
Response
200 Success
Under data, an array of unitOfMeasuresRow:
| 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. Example: "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45". |
unitCode |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The short code of the unit of measure, for example 'KG'. It is unique within the tenant. Example: "KG". |
unitName |
string | no | no | yes | The display name of the unit of measure, for example 'Kilogram'. Example: "Kilogram". |
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 record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-05-12T09:30:00.000Z". |
{
"data": [
{
"id": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
"unitCode": "KG",
"unitName": "Kilogram",
"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