---
title: "List my inventory via API key"
method: GET
path: "/v1/external/inventory"
tags: ["External"]
---

# List my inventory via API key

`GET /v1/external/inventory`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/v1/external/inventory`
- Auth: none declared

List the API-key owner's inventory rows. Same filters as /v1/inventory/.

## Query parameters

- `status` 'owned' | 'wanted' | 'for_sale' | 'sold' | 'discarded'
- `product_id` integer, nullable
- `project` string, nullable
- `q` string, nullable
- `limit` integer
- `offset` integer

## Headers

- `X-API-Key` string, nullable

## Response `200`

Successful Response

- InventoryItemOut[]
  - `id` integer, required
  - `user_id` integer, required
  - `product_id` integer, nullable
  - `status` 'owned' | 'wanted' | 'for_sale' | 'sold' | 'discarded', required
  - `name` string, nullable
  - `quantity` string, required
  - `notes` string, nullable
  - `acquisition_price` string, nullable
  - `acquisition_currency` string, nullable
  - `purchased_at` string, date-time, nullable
  - `asking_price` string, nullable
  - `asking_currency` string, nullable
  - `condition` string, nullable
  - `external_link` string, nullable
  - `external_id` string, nullable
  - `project` string, nullable
  - `recipient_id` integer, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `product` InventoryProductBasic: Compact product info embedded in inventory responses.
    - `id` integer, required
    - `name` string, required
    - `price` string, nullable
    - `currency` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/rubenayla/apis/partle-api.md) · [All operations](https://skmtc.dev/rubenayla/apis/partle-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rubenayla/apis/partle-api/revisions/628cce2acee5?raw)
