> For the complete documentation index, see [llms.txt](https://docs.claret.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.claret.app/api-reference/transactional-data/tenant-public-inventory-index.md).

# Tenant.public.inventory.index

```json
{"openapi":"3.1.0","info":{"title":"Claret","version":"1.0.0"},"tags":[{"name":"Transactional Data","description":"Sales, inventory, supply plans, and financial plans. Large datasets with cursor pagination."}],"servers":[{"url":"https://plan.claret.app/{tenant}/api/v1","description":"Production","variables":{"tenant":{"default":"your-tenant","description":"Your Claret tenant identifier (the slug in your Claret URL)."}}}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","scheme":"bearer"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error overview."}},"required":["message"]}}}},"ValidationException":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Errors overview."},"errors":{"type":"object","description":"A detailed description of each field that failed validation.","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["message","errors"]}}}}}},"paths":{"/inventory":{"get":{"operationId":"tenant.public.inventory.index","tags":["Transactional Data"],"parameters":[{"name":"filter[item_id]","in":"query","schema":{"type":"integer"}},{"name":"filter[item_name]","in":"query","schema":{"type":"string","maxLength":255}},{"name":"filter[uom_id]","in":"query","schema":{"type":"integer"}},{"name":"filter[bin_id]","in":"query","schema":{"type":"integer"}},{"name":"filter[bin_name]","in":"query","schema":{"type":"string","maxLength":255}},{"name":"filter[lot_id]","in":"query","schema":{"type":"integer"}},{"name":"filter[lot_name]","in":"query","schema":{"type":"string","maxLength":255}},{"name":"filter[location_id]","in":"query","schema":{"type":"integer"}},{"name":"filter[location_name]","in":"query","schema":{"type":"string","maxLength":255}},{"name":"filter[external_system_id]","in":"query","schema":{"type":"string","maxLength":255}},{"name":"filter[date_filled_from]","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"filter[date_filled_to]","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"filter[quantity_from]","in":"query","schema":{"type":"number"}},{"name":"filter[quantity_to]","in":"query","schema":{"type":"number"}},{"name":"sort","in":"query","schema":{"type":"string","maxLength":255}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":5000}},{"name":"cursor","in":"query","schema":{"type":"string"}},{"name":"include","in":"query","schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","const":"Inventory retrieved successfully."},"data":{"type":"array","prefixItems":[{"type":"array","items":{}}],"minItems":1,"maxItems":1,"additionalItems":false},"meta":{"anyOf":[{"type":"array","items":{}},{"type":"string"}]},"links":{"type":"string"}},"required":["message","data","meta","links"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"$ref":"#/components/responses/ValidationException"}}}}}}
```