List Unit Group Units

Beta

GET/v1/catalog/unit-groups/{unit_group_id}/units

This endpoint is idempotent. Learn more

Returns a list of associated units within a unit group.

Permissions requiredValues:unit_groups:read

The role behind your API key or agent must grant every one of these permissions.

unit_group_idstring

Unit group ID.

include[]optional arrayenumValues:unit

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while 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 unit_group_unit

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitunitExpandablenullable

The unit this association refers to.

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

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

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.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

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.

discount_percentagenumber

Percentage discount applied to the unit's price when an order is placed in this unit (e.g. 10 is a 10% discount).

discount_fixednumber

Flat amount subtracted from the unit's price when an order is placed in this unit.

customer_portal_visibilitystringenumValues:visiblehidden

Whether this unit is shown to customers in the customer portal.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Unit Group Units

List Unit Group Units

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listUnitGroupUnit = await client.catalog.unitGroups.units.list(
  'ug_01aad07abb8e41fd392d2d7013',
);

console.log(listUnitGroupUnit.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listUnitGroupUnit = await client.catalog.unitGroups.units.list(
  'ug_01aad07abb8e41fd392d2d7013',
);

console.log(listUnitGroupUnit.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/catalog/unit-groups/ug_01aad07abb8e41fd392d2d7013/units?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidWd1XzAxZDc1ZTA1OThlZDA5YmU1NmZkMzlmYWI1IiwiZCI6ImYifQ.RfJx7lOf7uqBgFqI8z1sBYJ1KS_wKll4YGP6hbySETg",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ugu_01d75e0598ed09be56fd39fab5",
      "object": "unit_group_unit",
      "unit": {
        "id": "un_01966263f74a5a0cae356000a1",
        "object": "unit",
        "name": "Kilogram",
        "abbreviation": "kg",
        "type": "mass",
        "ratio_numerator": "1000",
        "ratio_denominator": "1",
        "offset_numerator": "0",
        "offset_denominator": "1",
        "is_base_unit": false,
        "owner": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "discount_percentage": 1,
      "discount_fixed": 0,
      "customer_portal_visibility": "visible",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/catalog/unit-groups/ug_01aad07abb8e41fd392d2d7013/units?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidWd1XzAxZDc1ZTA1OThlZDA5YmU1NmZkMzlmYWI1IiwiZCI6ImYifQ.RfJx7lOf7uqBgFqI8z1sBYJ1KS_wKll4YGP6hbySETg",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ugu_01d75e0598ed09be56fd39fab5",
      "object": "unit_group_unit",
      "unit": {
        "id": "un_01966263f74a5a0cae356000a1",
        "object": "unit",
        "name": "Kilogram",
        "abbreviation": "kg",
        "type": "mass",
        "ratio_numerator": "1000",
        "ratio_denominator": "1",
        "offset_numerator": "0",
        "offset_denominator": "1",
        "is_base_unit": false,
        "owner": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "discount_percentage": 1,
      "discount_fixed": 0,
      "customer_portal_visibility": "visible",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Unit Group Units

Authorization

Path Parameters

Query Parameters

Returns

Responses