Get Work Orders

get

https://{dc-region}.zuperpro.com/api/service_orders

Operates on Service Orders, shown in the Zuper client app as "Work Order" (in every industry). Work Orders share the exact same underlying schema and endpoints as Purchase Orders / Material Orders; they're distinguished only by the purchase_order_type field (SERVICE_ORDER here) and the /service_orders route prefix. purchase_order_type is always enforced server-side based on this route; you cannot use this endpoint to read the other module's records.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter.keyword

string

filter.is_active

string

filter.vendor

string

vendor_uid

filter.created_from_date

date

filter.created_to_date

date

filter.due_from_date

date

filter.due_to_date

date

filter.purchase_order_from_date

date

filter.purchase_order_to_date

date

filter.created_by

string

user uid

filter.status

string

filter.updated_at_from

date

filter.updated_at_to

date

filter.job

string

Job uid

filter.estimate

string

Quote uid

filter.reference_number

string

filter.purchase_order_number

string

filter.await_approval_from

string

filter.purchase_order_uid

string

page

string

Default "1".

limit

string

Default "10". Also accepts count as an alias.

sort

string

"ASC" or "DESC", default "DESC" (by created_at).

cursor

string

Opaque cursor for cursor-based pagination.

prev_cursor

string

Opaque cursor for the previous page.

cursor_pagination

string

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

include_deleted

string

Set to include soft-deleted records.

fields_to_select

string

Sparse fieldset selector.

filter.project

string

Project UID.

filter.asset

string

Asset UID.

filter.material_request

string

Material Request UID.

filter.appointment_uid

string

Comma-separated appointment UIDs.

filter.parent_po

string

filter.current_delivery_status

string

filter.supplier_order_ref

string

filter.delivery_method

string

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200