Get by ID

GET

/oort/task_groups/v1/:id

GET

/oort/task_groups/v1/:id

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

Try it

200Retrieved

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

Retrieves a specific task group by ID with its associated tasks.

Authentication

AuthorizationBearer

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

Path Parameters

idstringRequired

Response

Successful Response

task_groupobject

taskslist of objects

Authentication

Path Parameters

Response

Errors