Organization API

List Material Requests

Lists the organization's Material Requests — the materials ordered for project work, tracked through ordering, receipt, and pickup — with their line items. Filter by workOrderId, projectId (a request is on a Project through its project step or its Work Order), status, or updatedSince for incremental sync; a change to a line item counts as a change to its request. Deleted requests are not returned; a cancelled request has status CANCELLED. Required scope: material_reqs:read.

/api/v1/material-reqs

List Material Requests. Use an organization API key with material_reqs:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

material_reqs:read

Parameters

Name	In	Type	Description
limit	query	integer	Maximum records to return. Defaults to 50 and is capped at 100.
cursor	query	string	Opaque record cursor from the previous response meta.nextCursor value.
sortDir	query	asc \| desc	Sort direction. Defaults to desc.
workOrderId	query	string	Only Material Requests for this Work Order.
projectId	query	string	Only Material Requests on this Project.
status	query	PENDING \| ORDERED \| PARTIALLY_RECEIVED \| RECEIVED \| READY_FOR_PICKUP \| PICKED_UP \| CANCELLED	Filter by Material Request status.
updatedSince	query	string	ISO 8601 date-time with Z or a UTC offset. Only Material Requests changed at or after this time, including changes to their line items.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Material Request list envelope

#/components/schemas/MaterialRequestListEnvelope

400

UNSUPPORTED_FILTER: an unknown status. VALIDATION_FAILED: an updatedSince that is not a date-time with Z or a UTC offset.