Low Stock Report | Ply | API Documentation

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

Requires scope: reports:read

API_KEYstring

API Key authentication via header

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).

sortstringOptional

Sort field and direction (e.g., name,asc or createdAt,desc). Supports Spring Pageable format.

This endpoint returns an object.

datalist of objects

paginationobject

Pagination metadata returned on all list endpoints.

401

Unauthorized Error

403

Forbidden Error

$	curl -G https://api.getply.com/api/v1/reports/low-stock \
>	-H "API_KEY: <apiKey>" \
>	-d locationIds=c3d4e5f6-a7b8-9012-cdef-123456789012