List Work Orders

GET

/work-orders

GET

/work-orders

1 curl -G https://https//https/work-orders \
2      -H "{{tenant_key_name}}: X-Tenant-ID" \
3      -H "Content-Type: application/json" \
4      --data-urlencode include=customer,tags,dispatch_tags

200Retrieved

1 {
2   "workOrders": [
3     {
4       "id": "WO-20240601-001",
5       "status": "In Progress",
6       "customer": {
7         "id": "CUST-1001",
8         "name": "Acme Corporation"
9       },
10       "service": "HVAC Maintenance",
11       "assignedTo": "Technician John Doe",
12       "scheduledDate": "2024-06-15T09:00:00Z",
13       "tags": [
14         "priority-high",
15         "warranty"
16       ],
17       "dispatch_tags": [
18         "urgent",
19         "safety-check"
20       ]
21     },
22     {
23       "id": "WO-20240601-002",
24       "status": "Scheduled",
25       "customer": {
26         "id": "CUST-1002",
27         "name": "Global Industries"
28       },
29       "service": "Electrical Inspection",
30       "assignedTo": "Technician Jane Smith",
31       "scheduledDate": "2024-06-16T13:30:00Z",
32       "tags": [
33         "routine",
34         "annual"
35       ],
36       "dispatch_tags": [
37         "inspection"
38       ]
39     }
40   ],
41   "pagination": {
42     "page": 1,
43     "pageSize": 20,
44     "totalPages": 5,
45     "totalItems": 85
46   }
47 }

Get a paginated list of all work orders.

Required Permission: view_work_orders

Tags: include tags and dispatch tags with include=…,tags,dispatch_tags.

Query parameters

includestringOptional

Response

Successful response

Headers

Query parameters

Response