Get Single Trip API
Explore how to get a single trip with our Trip API
Get Trip
GET
https://api.roam.ai/v2/trips/:id
Returns the trip with the given ID.
Path Parameters
Name
Type
Description
id*
String
Retrieves the trip with the given ID.
Headers
Name
Type
Description
Authorization*
String
Bearer <API-KEY>
{
"code": 200,
"message": "trip_object",
"description": "The details of trip for requested id.",
"has_more": false,
"trips":
{
"id": "620f26ad9ba7360496bc1be7",
"name": "Test Delivery",
"description": "item pickup for test users",
"trip_state": "created",
"total_distance": 0,
"total_duration": 0,
"total_elevation_gain": 0,
"metadata": {
"_id": 21,
"order_id": "1123"
},
"start_location": {},
"end_location": {},
"user": {
"id": "61ffb486d2c69840ee518073",
"name": "",
"description": "1200",
"metadata": {
"Mobile": "1234567890",
"Name": "Nikhil"
}
},
"started_at": null,
"ended_at": null,
"created_at": "2022-02-18T04:55:09.660",
"updated_at": "2022-02-18T04:55:09.660",
"events": [],
"stops": [
{
"id": "620f26ad9ba7360496bc1be5",
"name": "Delivery",
"description": "test Pickup for Johan",
"metadata": {
"order_id": "1120"
},
"address": "Flat NO 121 MG road ",
"geometry_radius": 20,
"geometry": {
"type": "Point",
"coordinates": [
77.6879689,
27.4072289
]
},
"created_at": "2022-02-18T04:55:09.658",
"updated_at": "2022-02-18T04:55:09.658",
"arrived_at": null,
"departed_at": null
},
{
"id": "620f26ad9ba7360496bc1be6",
"name": "Delivery",
"description": "another tester Pickup for Johan",
"metadata": {
"order_id": "1129"
},
"address": "teacher colony ",
"geometry_radius": 200,
"geometry": {
"type": "Point",
"coordinates": [
77.6925657818137,
27.422398561298454
]
},
"created_at": "2022-02-18T04:55:09.659",
"updated_at": "2022-02-18T04:55:09.659",
"arrived_at": null,
"departed_at": null
}
]
}
}
{
"code" : 400,
"message" : "invalid_request_error",
"description": "The request was unacceptable, due to missing a required parameter or invalid parameter.",
"errors" : [
{
"field" : "id",
"message" : "This field should be a valid trip id"
}
]
}
Example
curl --location --request GET 'https://api.roam.ai/v2/trips/620f26ad9ba7360496bc1be7' \
--header 'Authorization: Bearer dfbbf5d5ff6b41ecb1166147b87c0544'
Last updated