API ReferenceMaterials

List Materials

Returns a paginated list of materials for the authenticated business. By default, results are sorted by name ascending; callers can override this using the sort query parameter.

Requires scope: materials: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.

sortstringOptional

Sort by field,direction (Spring Pageable format; direction asc or desc, default asc). Allowed fields: id, name, itemNumber, brand, manufacturer, description, materialType, active, serialized, createdAt, updatedAt. Default order (when no sort is supplied): updatedAt,desc.

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