HTTP APIModules
Inventory
HTTP endpoints for inventory data.
Feature flag: inventory
Required permission: inventory:view
List Items
GET /api/v1/inventory/items| Query | Required | Description |
|---|---|---|
organizationId | No | Legacy override. The API key organization is used by default. |
limit | No | Positive maximum number of items |
search | No | Case-insensitive match against name, description, SKU, or barcode |
status | No | Draft, Active, Inactive, or Discontinued |
fields | No | Comma-separated response fields, for example _id,name,quantity |
curl "https://api.karybase.com/api/v1/inventory/items?status=Active&limit=50" \
-H "Authorization: Bearer $KARYBASE_API_KEY"curl "https://api.karybase.com/api/v1/inventory/items?fields=_id,name,quantity" \
-H "Authorization: Bearer $KARYBASE_API_KEY"{
"data": [
{
"_id": "item_123",
"organizationId": "org_123",
"name": "Camera Kit",
"sku": "CAM-001",
"status": "Active",
"quantity": 12
}
],
"organizationId": "org_123",
"count": 1
}Get Item
GET /api/v1/inventory/item| Query | Required | Description |
|---|---|---|
itemId | Yes | Inventory item id |
organizationId | No | Legacy override. The API key organization is used by default. |
fields | No | Comma-separated response fields, for example _id,name,customFields |
curl "https://api.karybase.com/api/v1/inventory/item?itemId=item_123" \
-H "Authorization: Bearer $KARYBASE_API_KEY"{
"data": {
"_id": "item_123",
"organizationId": "org_123",
"name": "Camera Kit",
"status": "Active"
}
}