Skip to main content
GET
Stock

Authorizations

X-API-Key
string
header
required

Integration API Key (Integrations → New Integration).

Query Parameters

branch_id
string<uuid>
required

Branch (GET /branches). From another business → 404.

Searches by name, SKU, or barcode (max. 100).

low_stock
boolean

1 = only products at or below the minimum.

per_page
integer
default:50

Results per page (1–200, default 50).

Required range: 1 <= x <= 200
page
integer

Page.

Required range: x >= 1

Response

Success

status
boolean
required
Example:

true

data
object
required