List Unit Groups

Beta

GET/v1/catalog/unit-groups

This endpoint is idempotent. Learn more

Returns a paginated list of unit groups, including system unit groups.

cursoroptional string

Cursor from a previous response's next_cursor field, used to fetch the next page.

limitoptional integer

Maximum number of results per page (default: 100, max: 1000).

qoptional string

Search query used to filter results.

typeoptional stringenumValues:currencyquantitytime

Unit type filter (e.g. "mass", "quantity").

include[]optional arrayenumValues:ownerowner.accountbase_unit

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

objectstringenumValues:list

Object type for UnitGroup list

page_infoobject

Pagination metadata for UnitGroup 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 UnitGroup resources in this page

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:currencyquantitytime

Unit type.

base_unitobjectExpandablenullable

Base unit.

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.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

associated_unitsobjectExpandablenullable

Associated units.

objectstringenumValues:list

Object type for UnitGroupUnit list

page_infoobject

Pagination metadata for UnitGroupUnit 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 UnitGroupUnit resources in this page

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitobjectnullable

Unit.

Always returned as null in this endpoint.

discount_percentagenumber

Discount percentage.

discount_fixednumber

Fixed discount amount.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerobjectExpandablenullable

Owner.

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)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Unit Groups

List Unit Groups

curl API_HOST/v1/catalog/unit-groups \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1"

curl API_HOST/v1/catalog/unit-groups \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1"

200 example

{
  "object": "list",
  "page_info": {
    "next_cursor": "ug_01jm4r6700f8nwq3v5hx2d9ktp",
    "prev_cursor": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ug_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "unit_group",
      "name": "Weight",
      "notes": null,
      "type": "mass",
      "base_unit": null,
      "associated_units": null,
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_cursor": "ug_01jm4r6700f8nwq3v5hx2d9ktp",
    "prev_cursor": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ug_01jm4r6700f8nwq3v5hx2d9ktp",
      "object": "unit_group",
      "name": "Weight",
      "notes": null,
      "type": "mass",
      "base_unit": null,
      "associated_units": null,
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Unit Groups

Query Parameters

Returns

Responses