List stocktakes
LogsGET /inventory/stocktakes
Pages the stocktakes with limit (default 20, max 100) and the after cursor. Filter by location_id and by status (counting or approved). Needs the inventory:read scope.
Parameters
location_idOne location
statuscounting or approved
one of
counting,approvedlimitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Returns
200 Stocktakes
Show attributes
dataShow child attributes
idstk_ identifier
tenant_idlocation_idstatusone of
counting,approvedreasoncreated_byfrozen_atapproved_byapproval_reasonapproved_atlinesShow child attributes
item_idexpectedQuantity in the item's unit, with at most three decimals (12.5 metres).
expected_serialscountedQuantity in the item's unit, with at most three decimals (12.5 metres).
counted_serialsdifferenceQuantity in the item's unit, with at most three decimals (12.5 metres).
unit_cost_minordifference_value_minorcounted_bycounted_at
difference_value_minorcreated_atupdated_at
has_morenext_cursor
Permissions inventory:read · Roles: admin, analyst, field_reader, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/inventory/stocktakes" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/inventory/stocktakes", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/inventory/stocktakes",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/inventory/stocktakes", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "inv_24EVJwEl7uYvnWsNvQCjjGAh7m0",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"location_id": "loc_2NbCeVvmOLLm0vFE4ZvkGRtMsrx",
"status": "counting",
"reason": "Leitura confirmada no local.",
"created_by": "created by",
"frozen_at": "2026-11-19T09:30:00Z",
"approved_by": "approved by",
"approval_reason": "approval reason",
"approved_at": "2026-11-19T09:30:00Z",
"lines": [
{
"item_id": "itm_2vLmKDHWenXi6Pxs8hv8WJHGW53",
"expected": 1,
"expected_serials": [
"expected serial"
],
"counted": 1,
"counted_serials": [
"counted serial"
],
"difference": 1,
"unit_cost_minor": 1,
"difference_value_minor": 1342,
"counted_by": "counted by",
"counted_at": "2026-11-19T09:30:00Z"
}
],
"difference_value_minor": 1342,
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}