Uber Developers

List All Guest Trips

GEThttps://api.uber.com/v1/guests/trips

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

¶ Use case

Use this endpoint to retrieve information for a set of trips.

By default, without any parameters, this endpoint will return the 50 most recent trips associated with the application making the call.

If the request is from a third party (3P) app, please add x-uber-organizationuuid header and the Organization UUID as the value or the request will be denied.

Use URL parameters to filter the results.

¶ Authorization

OAuth 2.0 Bearer token with the guests.trips scope.

¶ Request

¶ Example request

curl -X GET \
  -H "authorization: Bearer $UBER_TOKEN" \
  -H 'content-type: application/json' \
  'https://api.uber.com/v1/guests/trips?trip_status=PAST&start_key=XXX&limit=10'

¶ Request Query parameters

URL parameter	Type	Description
trip_status	string	A ride status to filter the response by {ACTIVE, PAST, EXPIRED}. Optional, if not specified will default to ACTIVE trips.
start_key	string	Key used for paging. When implementing paging, the value returned in next_key should be used here to retrieve the next page of results.
limit	int	The max number of rides to return. (Default 50)
include_editable_fields	bool	When set to true, this option includes editable fields in the response. If omitted or set to false, editable fields are excluded. (optional)

¶ Response

¶ Example response

{
  "next_key": "<next_key>",
  "trips": [
    {
      "begin_trip_time": 1564758770000,
      "can_tip": true,
      "client_fare": "$10.41",
      "client_fare_without_tip": "$10.41",
      "currency_code": "USD",
      "destination": {
        "address": "Bryant Park, New York, NY 10018",
        "latitude": 40.7535965,
        "longitude": -73.9832326,
        "place": {
          "place_id": "ChIJvbGg56pZwokRp_E3JbivnLQ",
          "provider": "google_places"
        },
        "subtitle": "New York, NY 10018",
        "timezone": "America/New_York",
        "title": "Bryant Park"
      },
      "driver": {
        "id": "42d53206-d8ba-5d5e-9f9b-c9e4a33d3a4c",
        "name": "Joe",
        "picture_url": "https://d1w2poirtb3as9.cloudfront.net/exampleurl",
        "rating": 4.9,
        "regulatory_info": "Licensed by TfL, PHL 123456789",
        "pin_based_phone_number": {
          "phone_number": "+11234567891",
          "pin": "12345678"
        }
      },
      "dropoff_time": 1564758815000,
      "expense_memo": "Memo note example",
      "guest": {
        "first_name": "Tom",
        "guest_id": "b7c5e97e-eb5a-5997-a95d-977a5c50d98a",
        "last_name": "Example",
        "locale": "en",
        "phone_number": "+11234567890"
      },
      "location_uuid": "a18860d5-ffee-429f-acb3-2f74641a0bf9",
      "note_for_driver": "Example note to driver",
      "pickup": {
        "address": "Lincoln Square, New York, NY",
        "latitude": 40.77417690000001,
        "longitude": -73.98491179999999,
        "place": {
          "place_id": "ChIJYWvLK15YwokR9nuSX-MHTZA",
          "provider": "google_places"
        },
        "subtitle": "New York, NY",
        "timezone": "America/New_York",
        "title": "Lincoln Square"
      },
      "product": {
        "display_name": "UberX",
        "product_id": "b8e5c464-5de2-4539-a35a-986d6e58f186"
      },
      "request_id": "da790cea-31b4-4131-8cd9-7adb1c06db99",
      "request_time": 1564758590000,
      "requester_name": "David Example",
      "requester_uuid": "f3a604eb-8b90-4068-932c-13d6a5002f86",
      "status": "completed",
      "surge_multiplier": 1,
      "trip_distance_miles": 0.01770572790936,
      "trip_duration_seconds": 900,
      "trip_end_location": {
        "latitude": 40.7530483614,
        "longitude": -73.9837700287
      },
      "vehicle": {
        "make": "Oldsmobile",
        "model": "Intrigue",
        "vehicle_color_name": "white",
        "license_plate": "ABC1234"
      },
      "waypoints": [
        {
          "latitude": 40.7741769,
          "longitude": -73.9849118,
          "type": "pickup"
        },
        {
          "latitude": 40.7535965,
          "longitude": -73.9832326,
          "type": "dropoff"
        }
      ],
      "editable_fields": {
        "PICKUP": {
          "editable": false,
          "max_radius_meters": 200
        },
        "STOPS": {
          "editable": false
        },
        "DROPOFF": {
          "editable": false
        }
      }
    }
  ]
}

¶ Response body parameters

Field	Type	Description
next_key	string	Key used to request the next page of results. An empty value indicates there are no more records to paginate.
trips	array	An array of trip objects. See the object definition in GET /v1/guest/trips/{}.

For trip item parameter details see the GET /v1/guests/trips/{} trips item parameter section.

¶ Endpoint Possible Errors

HTTP Status	Code	Description
401	unauthorized	Authentication failed. The client lacks valid authentication credentials for the requested resource.
403	forbidden	The client does not have permission to access the requested resource.
404	not_found	The requested resource or entity could not be found on the server or in the database.
500	internal_server_error	An unexpected error occurred on the server while processing the request.