List by courier org

GET

/oort/task_groups/by_courier_org_id/list/v1

GET

/oort/task_groups/by_courier_org_id/list/v1

1 curl https://localhost:8000/oort/task_groups/by_courier_org_id/list/v1 \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "task_groups": [
3     {
4       "task_group": {
5         "schema_version": 1,
6         "_id": "string",
7         "order_id": "string",
8         "order_short_id": "string",
9         "task_ids": [
10           "string"
11         ],
12         "courier_org_id": "string",
13         "order_cancelled": false,
14         "status": "not_started",
15         "driver_id": "string",
16         "started_at": "2024-01-15T09:30:00Z",
17         "completed_at": "2024-01-15T09:30:00Z",
18         "completed": false,
19         "paused": false
20       },
21       "tasks": [
22         {
23           "schema_version": 1,
24           "_id": "string",
25           "order_id": "string",
26           "order_short_id": "string",
27           "created_by_org_id": "string",
28           "created_by_user_id": "string",
29           "location": {
30             "type": "string",
31             "geometry": {
32               "bbox": [
33                 "string"
34               ],
35               "type": "string",
36               "coordinates": [
37                 "string"
38               ]
39             },
40             "bbox": [
41               "string"
42             ],
43             "properties": {
44               "address": "string",
45               "name": "string",
46               "mapbox_id": "string"
47             },
48             "id": 1
49           },
50           "action": "pickup",
51           "shipper_contact_info_ids": [
52             "string"
53           ],
54           "arrive_by": "2024-01-15T09:30:00Z",
55           "arrive_at": "2024-01-15T09:30:00Z",
56           "comments": "string",
57           "flight_number": "string",
58           "order_cancelled": false,
59           "completed": false,
60           "completed_at": "2024-01-15T09:30:00Z",
61           "cargo_ids": [
62             "string"
63           ],
64           "milestone_ids": [
65             "string"
66           ]
67         }
68       ]
69     }
70   ]
71 }

Lists all task groups assigned to the authenticated courier organization with their associated tasks.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response

task_groupslist of objects