Get Multiple Trips API

Explore how to get multiple trips with our Trip API

Get Multiple Trips

GET https://api.roam.ai/v2/trips

Returns a list of your trips.

Query Parameters

Name	Type	Description
starting_after	String	A cursor for use in pagination. starting_after is a trip id that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
ending_before	String	A cursor for use in pagination. ending_before is a trip id that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
created_at	Condition	A filter on the list based on the object created_at field.
description	Condition	A filter on the list based on the object description field.
trip_state	Condition	A filter on the list based on the object trip_status field.
is_local	Condition	A filter on the list based on the object is_local field.
user_id	Conditon	A filter on the list based on the object user_id field.
limit	Number	A limit on the number of objects to be returned, between 1 and 100.

Headers

Name	Type	Description
Authorization*	String	Bearer <API-KEY>

201: Created Trip list

{
   "code": 200,
   "message": "trip_list_success",
   "description": "The lists of trips for requests filter and search options.",
   "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
               }
           ]
       },
       {
          ...
       },
       ...
   ]
}

400: Bad Request Invalid request

{
  "code" : 400,
  "message" : "invalid_request_error",
  "description": "The request was unacceptable, due to missing a required parameter or invalid parameter.",
  "errors" : [
    {
      "field" : "limit",
      "message" : "This field should be a number between 1 and 100"
    },
    {
       "field" : "created_at",
       "message" : "This field should be valid ISO date string"
    },
    {
       "field" : "is_local",
       "message" : "This field should be valid boolean value"
    }
  ]
}

The following logical operators are generally supported for filters.

Operator type	Operator
Equality operators	Equals eq Not equals ne Negation not In in
Relational operators	Less than lt Greater than gt Less than or equal to le Greater than or equal to ge
Conditional operators	And and Or or
Functions	Starts with startsWith Ends with endsWith Contains contains Like like

Example

cURL

curl --location --request GET 'https://api.roam.ai/v2/trips?limit=100&starting_after=61dec6e206f8a019b2402c0b&ending_before=61dec6e206f8a019b2402c0b&created_at=gt:2022-01-12T12:17:38.625&description=contains:Delivery&trip_state=eq:created&is_local=eq:true&user_id=eq:61dec6e206f8a019b2402c0b&stop_id=eq:61dec6e206f8a019b2402c0b' \
--header 'Authorization: Bearer <API-KEY>'