List Unit Group Units

Beta

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

This endpoint is idempotent. Learn more

Returns the units associated with a unit group, along with the discount and customer portal visibility applied to each.

Every association in the group is returned in a single response; this list is not paginated.

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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

Share of the unit's price removed when an order is placed in this unit.

Expressed as a decimal fraction rather than a whole number, so 0.1 is a 10% discount and 0 is no discount.

discount_fixednumber

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

Subtracted before discount_percentage is applied.

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 OpenMRP from '@openmrp/sdk';

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

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

console.log(listUnitGroupUnit.data);

import OpenMRP from '@openmrp/sdk';

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

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

console.log(listUnitGroupUnit.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/catalog/unit-groups/ug_andst6m79n41/units?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidWd1X3NmcnFxeml6NDlkdyIsImQiOiJmIn0.eHBxgT_orFX5JBNLFN7ejjaeA1MjEg4Wkwmb_l-QE9c",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ugu_sfrqqziz49dw",
      "object": "unit_group_unit",
      "unit": {
        "id": "un_82bd37dae5po",
        "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_andst6m79n41/units?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidWd1X3NmcnFxeml6NDlkdyIsImQiOiJmIn0.eHBxgT_orFX5JBNLFN7ejjaeA1MjEg4Wkwmb_l-QE9c",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ugu_sfrqqziz49dw",
      "object": "unit_group_unit",
      "unit": {
        "id": "un_82bd37dae5po",
        "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