List Dispatch Zones

GET

/dispatch/zones

GET

/dispatch/zones

1 curl -G https://https//https/dispatch/zones \
2      -H "{{tenant_key_name}}: X-Tenant-Key" \
3      -H "Content-Type: application/json" \
4      -d per_page=15 \
5      -d page=1

200Retrieved

1 {
2   "zones": [
3     {
4       "id": "zone-001",
5       "name": "Downtown Service Area",
6       "description": "Covers the central business district and nearby neighborhoods",
7       "boundaries": {
8         "type": "Polygon",
9         "coordinates": [
10           [
11             [
12               -122.4194,
13               37.7749
14             ],
15             [
16               -122.414,
17               37.779
18             ],
19             [
20               -122.408,
21               37.776
22             ],
23             [
24               -122.412,
25               37.77
26             ],
27             [
28               -122.4194,
29               37.7749
30             ]
31           ]
32         ]
33       },
34       "active": true,
35       "createdAt": "2023-11-01T08:30:00Z",
36       "updatedAt": "2024-05-10T12:00:00Z"
37     },
38     {
39       "id": "zone-002",
40       "name": "Uptown Service Area",
41       "description": "Includes residential and commercial zones north of downtown",
42       "boundaries": {
43         "type": "Polygon",
44         "coordinates": [
45           [
46             [
47               -122.425,
48               37.785
49             ],
50             [
51               -122.42,
52               37.79
53             ],
54             [
55               -122.415,
56               37.788
57             ],
58             [
59               -122.418,
60               37.783
61             ],
62             [
63               -122.425,
64               37.785
65             ]
66           ]
67         ]
68       },
69       "active": true,
70       "createdAt": "2023-12-15T09:00:00Z",
71       "updatedAt": "2024-04-20T15:45:00Z"
72     }
73   ],
74   "page": 1,
75   "per_page": 15,
76   "total_zones": 2
77 }

List all dispatch zones. Zones define geographic service areas used for technician assignment and routing.

Query parameters

per_pageintegerOptional

Optional: Results per page - default 15

pageintegerOptional

Optional: Page number - default 1

Response

Successful response

Headers

Query parameters

Response