Find work orders using powerful search, filtering, and sorting parameters.
Effectively finding work orders is critical for managing large volumes of work. The API provides a robust search endpoint with extensive filtering and sorting capabilities.
GET /workorders
Results are paginated by default.
page: (Integer) Page number (default: 1).per_page: (Integer) Items per page (default: 25, max: 100).GET /workorders?page=2&per_page=50Filters are query parameters prefixed with f_. You can combine multiple filters to narrow down results.
| Parameter | Description | Example |
|---|---|---|
f_work_order_id | Specific ID(s), comma-separated. | f_work_order_id=1005 |
f_project | Filter by Project ID or name. | f_project=55 |
f_client | Filter by Client ID or name. | f_client=20 |
f_assignment | Filter by assignment type or Provider ID. | f_assignment=12345 |
f_created | Date range (Start, End). | f_created=2025-01-01,2025-02-01 |
f_schedule | Service date range. | f_schedule=2025-01-01,2025-01-31 |
| Parameter | Description |
|---|---|
f_city | City name. |
f_state | State code (e.g., MN). |
f_postal_code | Zip code. |
Order your results using sort and order.
| Parameter | Description |
|---|---|
sort | Column ID to sort results by (e.g., work_order_id, created, service_window_start) |
order | Sort direction: asc (Ascending) or desc (Descending) |
Find all jobs in California, sorted by Service Date:
GET /workorders?f_state=CA&sort=service_window_start&order=ascCommon work order status stages:
| Status | Description |
|---|---|
| Draft | Not yet published |
| Published | Available in marketplace |
| Routed | Sent to specific providers |
| Assigned | Provider assigned |
| In Progress | Work started |
| Work Done | Awaiting approval |
| Approved | Payment processing |
| Paid | Complete |
| Cancelled | Work cancelled |
Last updated on