API ReferenceCatalog Items

List Catalog Units

Lists the units of measure available to your company (e.g. Each, Square Feet, Linear Feet). Use these IDs when setting unitId on a catalog item, or when linking measurements.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

include_archivedbooleanOptionalDefaults to false

Whether to include archived (inactive) records in the response. By default only active records are returned.

pageintegerOptional>=1Defaults to 1

Page number (1-based)

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

Response

List of catalog units
idinteger
Catalog unit identifier
codestring

Stable short code for the unit (e.g. “SF”, “EA”)

labelstring

Human-readable label for the unit (e.g. “Square Feet”)

dimensionenum or nullOptional

The physical dimension this unit measures, if any. Null for packaging-style units (e.g. bundle, roll) that can’t be used on a measurement.

isCustombooleanOptional
Whether this unit was defined by the company, as opposed to one of the seeded defaults.
isArchivedbooleanOptional
Whether this unit has been archived.

Errors

400
Bad Request Error
401
Unauthorized Error
502
Bad Gateway Error