Get Purchase Orders By Filter

Operates on Purchase Orders. In the Zuper client app this module is labeled "Purchase Order" for most companies, and "Material Order" for companies in the roofing industry — the API and data shape are identical either way. Purchase Orders and Work Orders (Service Orders) share the exact same underlying schema and endpoints; they're distinguished only by the purchase_order_type field (PURCHASE_ORDER here) and the /purchase_orders vs /service_orders route prefix. Rule-engine-based list endpoint — an alternative to the simple filter.* query params on the plain List endpoint, for building complex AND/OR filter conditions. purchase_order_type is enforced as a top-level query field (not injected into filter_rules) so it still binds correctly even when filter_rule_operator is "OR".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
Defaults to 1
string
Defaults to 10

Max 1000 — larger values are rejected with 400.

string
enum
Defaults to DESC
Allowed:
string
enum

Invalid values are rejected with 400 "Invalid Sort value".

Allowed:
filter_rules
array of objects

Rule-engine condition list.

filter_rules
string
enum
Defaults to AND
Allowed:
string
string
string

Set to enable cursor-based pagination instead of offset pagination.

string

Sparse fieldset selector.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json