Skip to main content
GET
List inventory

Authorizations

Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Query Parameters

brand
string

Filter by brand name.

Example:

"Coca-Cola"

category
string

Filter by category.

Example:

"Beverages"

sku
string

Filter by exact SKU code.

Example:

"CC-330ML-CAN"

projectId
string

Filter by project ID.

Example:

"prj_def456"

cursor
string

Opaque pagination cursor returned in the previous response.

limit
integer
default:25

Maximum number of items to return (default 25, max 100).

Required range: 1 <= x <= 100

Response

Paginated list of inventory items.

data
object[]
required
pagination
object
required

Cursor-based pagination metadata.