List asset unit rows
Assets module
GET/asset-unitsassetUnits.list
An individual asset tracked by serial or asset tag (unit grain), with a nine-value lifecycle. Returns a cursor page of asset unit rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability assets.asset.read.
- OAuth scopes: assets.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of AssetUnit
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the asset unit. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| asset_class_id | string (uuid) | Yes | Identifier of the asset class. |
| asset_tag | string | Yes | Asset tag (a code that is ours).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| asset_state | "Proposed" | "Received" | "Available" | "Reserved" | "Deployed" | "In Maintenance" | "Damaged" | "Lost" | "Retired" | Yes | Asset lifecycle state. |
| condition_enum_id | string | null | Yes | Condition: a row of the canon Asset Condition enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| home_venue_id | string (uuid) | null | Yes | Identifier of the venue the unit returns to. |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"asset_tag": "NWL-TR-0042",
"asset_state": "Available",
"condition_enum_id": "ENM-017",
"home_venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/asset-units" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.assetUnits.listAll()) {
console.log(row);
}for row in xos.asset_units.list_all():
print(row)xos asset-units list --all