GET
View a measurement category
Company space For: Manager · Permission: uom_categories.retrieve Part of Units of measure.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uom_category
string
required

Identifier of the unit-of-measure category (27-character KSUID).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: units.

Response

200 - application/json

Resource.

id

Identifier of the category (27-character KSUID).

name

Lowercase name of the category, unique within the organization.

units
array

Units of the category of the current organization. Present only when requested with include=units.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).