List Dispatch Rules

GET

/dispatch/rules

GET

/dispatch/rules

1 curl -G https://https//https/dispatch/rules \
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   "rules": [
3     {
4       "id": "rule-001",
5       "name": "High Priority Urgent Jobs",
6       "conditions": {
7         "jobType": "urgent",
8         "priority": "high",
9         "zone": "north"
10       },
11       "assignment": {
12         "autoAssign": true,
13         "assigneeGroup": "Senior Technicians"
14       },
15       "enabled": true,
16       "createdAt": "2024-05-10T09:15:00Z",
17       "updatedAt": "2024-05-20T11:00:00Z"
18     },
19     {
20       "id": "rule-002",
21       "name": "Standard Jobs in East Zone",
22       "conditions": {
23         "jobType": "standard",
24         "priority": "medium",
25         "zone": "east"
26       },
27       "assignment": {
28         "autoAssign": false,
29         "assigneeGroup": "Field Operators"
30       },
31       "enabled": true,
32       "createdAt": "2024-04-01T08:00:00Z",
33       "updatedAt": "2024-04-15T10:30:00Z"
34     }
35   ],
36   "total": 2,
37   "page": 1,
38   "per_page": 15
39 }

List all dispatch rules configured for the tenant. Rules define automatic assignment logic based on conditions like job type, priority, and zone.

Query parameters

per_pageintegerOptional

Optional: Results per page - default 15

pageintegerOptional

Optional: Page number - default 1

Response

Successful response

Headers

Query parameters

Response