List Materials | Ply | API Documentation

{
  "data": [
    {
      "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "name": "3/4 inch PVC Pipe (10ft)",
      "active": true,
      "serialized": false,
      "categories": [
        "Plumbing Supplies"
      ],
      "tags": [
        "plumbing",
        "pvc"
      ],
      "createdAt": "2026-01-15T09:00:00",
      "updatedAt": "2026-03-10T11:30:00",
      "itemNumber": "PVC-34-10",
      "brand": "Charlotte Pipe",
      "manufacturer": "Charlotte Pipe and Foundry",
      "description": "Schedule 40 PVC pipe for plumbing applications.",
      "materialType": null,
      "measurementUnit": "EA",
      "costForBusiness": 28.5,
      "costForClient": 38
    }
  ],
  "pagination": {
    "page": 0,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1
  }
}

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.

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

429

Rate Limit Error