Roam.ai Docs
HomeContactDashboard
Roam v1
Roam v1
  • Introduction
  • Getting Started
    • Key Concepts
  • Frameworks
  • Android
    • Quickstart (Android)
    • Pub/Sub Locations (Android)
    • SDK Methods (Android)
      • SDK Configuration (Android)
      • Get Current Location (Android)
      • Update Current Location (Android)
      • Update Location When Stationary (Android)
      • Trip v1 SDK Methods (Android)
      • Trip v2 SDK Methods (Android)
        • Create Trip (Android)
        • Update Trip (Android)
        • Start Quick Trip (Android)
        • Start Trip (Android)
        • End Trip (Android)
        • Pause Trip (Android)
        • Resume Trip (Android)
        • Sync Trip (Android)
        • Get Trip (Android)
        • Get Active Trips (Android)
        • Get Trip Summary (Android)
        • Subscribe to Trip (Android)
        • Delete Trip (Android)
    • Utility Methods (Android)
    • Troubleshooting (Android)
    • Changelog (Android)
  • iOS
    • Quickstart (iOS)
    • Pub/Sub Locations (iOS)
    • SDK Methods (iOS)
      • SDK Configuration (iOS)
      • Get Current Location (iOS)
      • Update Current Location (iOS)
      • Update Location When Stationary (iOS)
      • Trips v1 SDK Methods (iOS)
      • Trips v2 SDK Methods (iOS)
        • Create Trip (iOS)
        • Update Trip (iOS)
        • Start Quick Trip (iOS)
        • Start Trip (iOS)
        • End Trip (iOS)
        • Pause Trip (iOS)
        • Resume Trip (iOS)
        • Sync Trip (iOS)
        • Get Trip (iOS)
        • Get Active Trips (iOS)
        • Get Trip Summary (iOS)
        • Subscribe Trip (iOS)
        • Delete Trip (iOS)
    • Utility Methods (iOS)
    • Troubleshooting (iOS)
    • Changelog (iOS)
  • React Native
  • Flutter
  • PRODUCTS
  • Tracking (BETA)
  • Geofencing
  • Trips
  • APIs
    • Authorization
    • Users API
      • Create User API
      • Get User API
      • Update User API
    • Locations API
      • Get Locations API
      • Get Stop Locations API
    • Insights API
      • Get User POIs API
      • Get User Home Location API
      • Get User Work Location API
    • Trips v1 API
      • Create Trip API v1
      • Get Trip API
      • Update Trip API v1
      • Delete Trip API v1
      • Trip Summary API
      • Export Trip Summary as GPX
    • Trips v2 API
      • Create Trip API
      • Get Single Trip API
      • Get Multiple Trips API
      • Update Trip API
      • Control Trip API
        • Start Trip API
        • Pause Trip API
        • Resume Trip API
        • End Trip API
      • Get Trip Summary API
      • Export Trip API
      • Delete Trip API
    • Geofencing API
      • CREATE Geofence API
      • GET Geofence API
      • UPDATE Geofence API
      • DELETE Geofence API
    • Events API
      • Get Events
      • Trip Events
    • Nearby API
      • Get Nearby User API
      • Get Nearby Geofence API
    • Moving Geofence API
      • Create Moving-Geofence API
      • Update Moving-Geofence API
      • GET Moving-Geofence API
      • Delete Moving-Geofence API
    • User Groups API
      • Create Group API
      • Get User Group by ID
      • Get User Group List
      • Add Users to Group API
      • Update Group API
      • Find Nearby Users from Group
    • Query with Metadata
  • WEBHOOK
    • Webhook
    • Slack Integration
  • LIBRARIES
    • Javascript Library
    • Go Library
    • Python Library
Powered by GitBook
On this page
  • Get Trip
  • Example

Was this helpful?

Export as PDF
  1. APIs
  2. Trips v2 API

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'

PreviousCreate Trip APINextGet Multiple Trips API

Last updated 2 years ago

Was this helpful?