Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

dashboard
string
required

Query Parameters

version
integer | null

An earlier version to read instead of the newest.

Required range: x >= 1
filters[days]
integer | null

The last this many whole days, not counting today.

Required range: 1 <= x <= 3660
filters[from]
string<date> | null

The first day of a range, as YYYY-MM-DD; sent with to.

filters[to]
string<date> | null

The last day of a range, as YYYY-MM-DD; sent with from.

filters[locations][]
string<uuid>[]
filters[family]
string<uuid> | null

The id of an item family to keep.

Response

DashboardDetailResource

data
DashboardDetailResource · object
required