Topolo Docs Topolo Platform
Open workspace

List Inventory items

List all workspace items, including archived records, newest update first. Every quantityOnHand sums all signed ledger deltas across locations and review states; there is no pagination.

Outcome

List all workspace items, including archived records, newest update first. Every quantityOnHand sums all signed ledger deltas across locations and review states; there is no pagination.

Before you start

  • Verify the authenticated identity, exact environment and pinned approved organization context before preparing an action.
  • The published application permission is workspace:read. Discover a granted Inventory workspace and bind that exact resource. Supplied identifiers do not grant access.

Discover the target

topolo whoami --json
topolo actions get app_topolo_inventory.items.list --detail --json
topolo resources topolo-inventory --json
topolo workspaces list topolo-inventory --json
  • Select the exact granted workspace id as INVENTORY_WORKSPACE_ID. Fixture ids authorize no live operation.
  • Discover item ids through items.list or the reviewed items.create response in this workspace.

Request

GET /api/items

Save action input as payload.json. Inspect the plan for the exact path, query and body. Set INVENTORY_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console, then perform the verification below.

Input fields

Supply an empty input object; credential and resource context are separate.

View the complete input schema in the action console. The same schema is available through CLI and MCP action discovery.

Effects

  • Reads organization/workspace-scoped item rows and movement aggregates; archived items remain in the list.
  • No mirror or domain record is created. Stock is aggregated by item across every location, with no review-status filter or nonnegative floor.

Interpret the response

Use response path $.items[].id for inventory_item. An empty list does not discover a target.

Use items[].id for subsequent actions; an empty array discovers no item. Inspect status before recording movements and use quantityOnHand as aggregate signed ledger stock.

The success schema was checked against captured handler responses. Delegated Auth profile and canonical widget context fields can vary; exact Inventory projections and all six raw SQL export stores are source-reviewed. Error examples retain their actual refusal shapes.

View the complete success schema in the action console. The worked examples below retain complete captured responses; action discovery supplies the exact schema.

Worked examples

Captured exported Worker responses use both real local SQLite D1 databases with all six committed migrations, synthetic Auth/workspace grants and simulated Notify/Nexus/archive transport. They prove local handler shapes and scoped behavior, not live authorization, notification delivery, metering acceptance or environment deployment. Large 100-row list/capped-dashboard captures are retained in local evidence; committed tests verify those limits while worked guides use smaller complete responses. Refused examples demonstrate boundaries and must not be executed as successful workflows.

Successful request

Actual exported Worker response with both local SQLite D1 databases and all committed migrations; synthetic Auth/grants and simulated Notify/Nexus/archive transport. No live delivery, billing or environment deployment proof. Captured scenario: empty items.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_inventory.items.list --data @payload.json --json
topolo actions plan app_topolo_inventory.items.list --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_inventory.items.list --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_inventory.items.list",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "items": []
}

HTTP 200. Use items[].id for subsequent actions; an empty array discovers no item. Inspect status before recording movements and use quantityOnHand as aggregate signed ledger stock.

Another supported request

Actual exported Worker response with both local SQLite D1 databases and all committed migrations; synthetic Auth/grants and simulated Notify/Nexus/archive transport. No live delivery, billing or environment deployment proof. Captured scenario: list includes archived item.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_inventory.items.list --data @payload.json --json
topolo actions plan app_topolo_inventory.items.list --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_inventory.items.list --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_inventory.items.list",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "items": [
    {
      "id": "invitem_b29c4494-14e0-43dd-87e6-e33856f732af",
      "workspaceId": "ws_inventory_fixture",
      "sku": "KRAFT-MAILER-240X320",
      "name": "Kraft mailer 240x320",
      "description": "",
      "unit": "unit",
      "status": "archived",
      "lowStockThreshold": 0,
      "quantityOnHand": 0,
      "createdByUserId": "usr_inventory_fixture",
      "createdByEmail": "operator@example.test",
      "createdAt": "2026-10-04T05:46:36.190Z",
      "updatedAt": "2026-10-04T05:46:36.270Z"
    }
  ]
}

HTTP 200. Use items[].id for subsequent actions; an empty array discovers no item. Inspect status before recording movements and use quantityOnHand as aggregate signed ledger stock.

Another supported request

Actual exported Worker response with both local SQLite D1 databases and all committed migrations; synthetic Auth/grants and simulated Notify/Nexus/archive transport. No live delivery, billing or environment deployment proof. Captured scenario: populated items.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_inventory.items.list --data @payload.json --json
topolo actions plan app_topolo_inventory.items.list --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_inventory.items.list --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_inventory.items.list",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "items": [
    {
      "id": "invitem_b29c4494-14e0-43dd-87e6-e33856f732af",
      "workspaceId": "ws_inventory_fixture",
      "sku": "KRAFT-MAILER-240X320",
      "name": "Kraft mailer 240x320",
      "description": "",
      "unit": "unit",
      "status": "active",
      "lowStockThreshold": 0,
      "quantityOnHand": 0,
      "createdByUserId": "usr_inventory_fixture",
      "createdByEmail": "operator@example.test",
      "createdAt": "2026-10-04T05:46:36.190Z",
      "updatedAt": "2026-10-04T05:46:36.190Z"
    }
  ]
}

HTTP 200. Use items[].id for subsequent actions; an empty array discovers no item. Inspect status before recording movements and use quantityOnHand as aggregate signed ledger stock.

Verify the result

  • Use items[].id for subsequent actions; an empty array discovers no item.
  • Inspect status before recording movements and use quantityOnHand as aggregate signed ledger stock.

Errors and recovery

  • invalid_action_input (HTTP 400): Correct only the exact fields reported by the published schema validator. An invalid input can be refused before its handler.
  • action_permission_required (HTTP 403): Stop when the verified credential lacks the published action permission. Resource identifiers and organization ownership do not grant that permission.
  • organization_required (HTTP 403): Use the specifically authorized organization context; personal scope cannot act on organization-owned Inventory data.
  • workspace_required (HTTP 400): Discover an authorized Inventory workspace and pass its exact separate resource binding; bootstrap does not select a workspace.
  • workspaces_unavailable (HTTP 503): Retain the request id and report unavailable canonical workspace discovery; do not invent a default workspace.

Auth, action-input validation and platform resource resolution can refuse a request before its handler. Retain the exact error, request id and context; requesting another context is not a legitimate way to bypass a refusal.

Recovery boundary

The read does not change local inventory records. No local rollback is needed; do not perform a mutation merely to reverse a read.

  • Get Inventory item: Read one item in the granted workspace with descriptive fields, archive status and quantityOnHand computed from all its movements. Archived items remain readable; missing or foreign items return not_found.
  • Create Inventory item: Create an active item with zero stock in the granted workspace. Omitted SKU derives from the name, unit defaults to unit and threshold defaults to zero; an existing workspace/SKU uniqueness conflict is not an upsert.

Evidence

Captured exported Worker responses use both real local SQLite D1 databases with all six committed migrations, synthetic Auth/workspace grants and simulated Notify/Nexus/archive transport. They prove local handler shapes and scoped behavior, not live authorization, notification delivery, metering acceptance or environment deployment. Large 100-row list/capped-dashboard captures are retained in local evidence; committed tests verify those limits while worked guides use smaller complete responses. Capture digests and test scenarios are retained in the source fixture records.