List Material Availability | Ply

{
  "data": [
    {
      "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "name": "3/4 inch PVC Pipe (10ft)",
      "inventory": [
        {
          "location": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "Main Warehouse",
            "type": "WAREHOUSE",
            "integrationId": "WH-001"
          },
          "quantity": 120,
          "criticalAmount": 10,
          "lowAmount": 25
        },
        {
          "location": {
            "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
            "name": "Truck 7",
            "type": "TRUCK",
            "integrationId": null
          },
          "quantity": 12,
          "criticalAmount": 2,
          "lowAmount": 5
        }
      ],
      "totalQuantity": 132,
      "integrationId": "ST-998877",
      "qboId": "1042",
      "itemNumber": "PVC-34-10",
      "description": "Schedule 40 PVC pipe for plumbing applications.",
      "costForBusiness": 28.5,
      "costForClient": 38
    }
  ],
  "pagination": {
    "page": 0,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1
  }
}

Returns a paginated list of materials with their on-hand inventory aggregated per location. For each material the response includes one inventory entry per location that currently holds stock, plus a totalQuantity summed across those locations.

Job-site locations are excluded from the inventory breakdown. Results can be narrowed with a free-text search and limited to the business’s own materials.

Requires scope: materials:read

Returns a paginated list of materials with their on-hand inventory aggregated per location. For each material the response includes one `inventory` entry per location that currently holds stock, plus a `totalQuantity` summed across those locations. Job-site locations are excluded from the inventory breakdown. Results can be narrowed with a free-text search and limited to the business's own materials. Requires scope: `materials:read`

Authentication

API_KEYstring

API Key authentication via header

Query parameters

integrationIdstringOptional

Filter to the material linked to this external integration id (exact match against any integration, e.g. QBO, ServiceTitan, FieldEdge). When supplied, textToSearch and excludeGlobal are ignored.

textToSearchstringOptional

Free-text filter matched against material name, item number, brand and description.

excludeGlobalbooleanOptional

When true, returns only materials owned by the authenticated business and excludes global catalog materials. Defaults to false.

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). Sorting is applied to the underlying material’s fields, not to the availability response shape — so keys such as brand, manufacturer, materialType, active, serialized, createdAt and updatedAt are valid even though they are not returned in this response. 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`). Sorting is applied to the underlying material's fields, not to the availability response shape — so keys such as `brand`, `manufacturer`, `materialType`, `active`, `serialized`, `createdAt` and `updatedAt` are valid even though they are not returned in this response. 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

401

Unauthorized Error

403

Forbidden Error

$	curl https://api.getply.com/api/v1/materials/availability \
>	-H "API_KEY: <apiKey>"