List catalogue items
LogsGET /inventory/items
Pages the tenant's catalogue with limit (default 20, max 100) and the after cursor. Filter by kind (bulk or serialised), is_meter and active (true or 1 for true, any other value for false), and search with q. Needs the inventory:read scope.
Parameters
kindbulk or serialised
one of
bulk,serialisedis_meterOnly meter items
activeOnly active or inactive items
qResource-specific text search.
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Returns
200 Catalogue items
Show attributes
dataShow child attributes
iditm_ identifier
tenant_idcodenamedescriptionunitone of
un,m,kg,l,cx,rolokindone of
bulk,serialisedis_meterUnits are meters owned by the meter module
meter_manufacturermeter_modelmeter_diameter_mmreorder_levelQuantity in the item's unit, with at most three decimals (12.5 metres).
reorder_levelsShow child attributes
location_idlevelQuantity in the item's unit, with at most three decimals (12.5 metres).
standard_cost_minoraverage_cost_minorMoving weighted average cost per unit, in minor units of the tenant currency
activecreated_atupdated_at
has_morenext_cursor
Permissions inventory:read · Roles: admin, analyst, field_reader, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/inventory/items" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/inventory/items", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/inventory/items",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/inventory/items", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "inv_2gCDJwAl34EFzaahb8GfVEQrV6w",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"code": "COD-2026-000142",
"name": "Ana Matsinhe",
"description": "Leitura confirmada no local.",
"unit": "un",
"kind": "bulk",
"is_meter": true,
"meter_manufacturer": "meter manufacturer",
"meter_model": "meter model",
"meter_diameter_mm": 1,
"reorder_level": 1,
"reorder_levels": [
{
"location_id": "loc_2NbCeVvmOLLm0vFE4ZvkGRtMsrx",
"level": 1
}
],
"standard_cost_minor": 1,
"average_cost_minor": 1,
"active": true,
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}