List Units

Beta
GET/v1/catalog/units

This endpoint is idempotent. Learn more

Returns a paginated list of units for the current account, including both account-owned and global system units.

cursoroptional string

Query parameter: cursor for List Units

limitoptional integer

Query parameter: limit for List Units

qoptional string

Query parameter: q for List Units

typeoptional stringenumValues:currencyquantitytime

Filter by unit dimension code.

unit_group_ids[]optional array

Filter by unit group membership.

include[]optional arrayenumValues:ownerowner.account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Object type for Unit list

page_infoobject

Pagination metadata for Unit list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of Unit resources in this page

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Unit dimension.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions. Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator. Typically 1.

is_base_unitboolean

Whether this is the base unit for its dimension. Conversion ratios are relative to this unit.

ownerobjectExpandablenullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.
default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.
brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.
portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

Responses

200

Successful response for List Units