Skip to navigation
API ReferenceReports

Low Stock Report

Returns materials at or below their configured low or critical quantity threshold. Optionally filter by one or more locations or search by name.

Ordered by most recently updated first. This report does not accept a sort parameter.

Requires scope: reports:read

Authentication

API_KEYstring
API Key authentication via header

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

locationIdslist of UUIDsOptional
Filter to specific location IDs. Returns all locations if omitted.
searchstringOptional

Filter by material name (partial match).

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Rate Limit Error