Get Guest Trip
GEThttps://api.uber.com/v1/guests/trips/{request_id}
¶ Use case
Use this endpoint to retrieve information for a specific trip.
If translation for product description and vehicle color fields are needed in the response of this call, please add the header Accept-Language
and specify the value (for example, to translate to French, use “FR” as the value for this header)
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.
¶ Authorization
OAuth 2.0 Bearer token with the guests.trips
scope.
¶ Request
¶ Example request
curl -X GET \
-H "authorization: Bearer $UBER_TOKEN" \
'https://sandbox-api.uber.com/v1/guests/trips/<request_id>'
¶ Request URL path parameters
URL path parameter | Type | Description |
---|---|---|
request_id |
string |
A unique identifier of a trips request returned when creating a trip (required) |
¶ Request Query parameters
URL path parameter | Type | Description |
---|---|---|
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 accepted
trip response with editable_fields
{
"destination": {
"address": "Bryant Park, New York, NY 10018",
"eta": 18,
"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",
"phone_number": "+11234567891",
"picture_url": "https://d1w2poirtb3as9.cloudfront.net/exampleurl",
"rating": 4.9,
"sms_number": "+11234567891",
"pin_based_phone_number": {
"phone_number": "+11234567890",
"pin": "12345678"
},
},
"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": {
"bearing": 0,
"latitude": 40.775573965137674,
"longitude": -73.98604690473967
},
"location_uuid": "a18860d5-ffee-429f-acb3-2f74641a0bf9",
"note_for_driver": "Example note to driver",
"pickup": {
"address": "Lincoln Square, New York, NY",
"eta": 1,
"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": 1564758590788,
"requester_name": "David Example",
"requester_uuid": "f3a604eb-8b90-4068-932c-13d6a5002f86",
"status": "accepted",
"surge_multiplier": 1,
"vehicle": {
"license_plate": "ABC1234",
"make": "Oldsmobile",
"model": "Intrigue",
"vehicle_color_name": "white"
},
"rider_tracking_url": "https://trip.uber.com/d8lVg6Sx9H",
"editable_fields": {
"PICKUP": {
"editable": false,
"max_radius_meters": 200
},
"STOPS": {
"editable": false
},
"DROPOFF": {
"editable": false
}
}
}
¶ Example in_progress
trip response
{
"begin_trip_time": 1564758770223,
"destination": {
"address": "Bryant Park, New York, NY 10018",
"eta": 17,
"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": "Example",
"phone_number": "+11234567891",
"picture_url": "https://d1w2poirtb3as9.cloudfront.net/exampleurl",
"rating": 4.9,
"sms_number": "+11234567891",
"pin_based_phone_number": {
"phone_number": "+11234567890",
"pin": "12345678"
},
},
"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": 1564758590788,
"requester_name": "David Example",
"requester_uuid": "f3a604eb-8b90-4068-932c-13d6a5002f86",
"status": "in_progress",
"surge_multiplier": 1,
"vehicle": {
"license_plate": "ABC1234",
"make": "Oldsmobile",
"model": "Intrigue",
"vehicle_color_name": "white"
}
}
¶ Example completed
trip response
{
"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,
"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"
}
]
}
¶ trips
item parameters
Name | Type | Description |
---|---|---|
begin_trip_time |
int |
The time in milliseconds when the driver starts the trip. Will be null unless the trip has begun. |
can_tip |
bool |
Whether or not the trip is eligible for a tip. This is only set on trips in a terminal state. |
client_fare |
string |
The formatted price of the trip. This is only set on trips in a terminal state. |
client_fare_numeric |
float |
The price of the trip as a float value. This is only set on trips in a terminal state. |
client_fare_without_tip |
string |
The formatted price of the trip excluding the tip. This is only set on trips in a terminal state. |
currency_code |
string |
The currency code for the currency of the trip price. This is only set on trips in a terminal state. |
deferred_ride_options.pickup_day |
string |
The deferred ride pickup day in format YYYY-MM-DD. This is only available for flexible rides. |
destination.address |
string |
The destination’s complete address. |
destination.eta |
int |
The estimated time in minutes until arrival at the destination. Only available during an ongoing trip. |
destination.latitude |
float |
The latitude of the destination. |
destination.longitude |
float |
The longitude of the destination. |
destination.place.place_id |
string |
The place ID in provider’s namespace. |
destination.place.provider |
string |
The name of a provider of location data, e.g. google_places. |
destination.subtitle |
string |
The destination city and state, where applicable. |
destination.timezone |
string |
The timezone at destination address. |
destination.title |
string |
The destination street address. |
driver |
object |
Root object of the driver of the trip. Not available if request status is processing, scheduled, or no_drivers_available. |
driver.id |
string |
The unique ID of the driver. |
driver.name |
string |
The first name of the driver. |
driver.phone_number |
string |
The formatted phone number for calling a driver in E.164 (international) format. Note, this may be different from driver.sms_number. This phone number can be used to call the driver when the trip status is “ACCEPTED” by the driver or the driver is “ARRIVING” or “IN_PROGRESS”. |
driver.sms_number |
string |
The formatted phone number in E.164 (international) format for sending an SMS message to a driver. Note, this may be different from driver.phone_number. This phone number can be used to text the driver when the trip status is “ACCEPTED” by the driver or the driver is “ARRIVING” or “IN_PROGRESS”. |
driver.rating |
float |
The driver’s star rating out of 5 stars. |
driver.picture_url |
string |
The URL to the photo of the driver. |
driver.pin_based_phone_number.phone_number |
string |
The formatted phone number for calling a driver using the pin. |
driver.pin_based_phone_number.pin |
string |
The pin for calling a driver on the phone number provided. |
dropoff_time |
int |
The time in milliseconds when the rider is dropped off and the trip is complete. Only available when the trip is completed. |
expense_memo |
string |
A free text field to describe the purpose of the trip for expense reporting. |
guest.guest_id |
string |
Unique identifier of a rider. |
guest.first_name |
string |
Rider’s first name. |
guest.last_name |
string |
Rider’s last name. |
guest.email |
string |
Rider’s email address. |
guest.phone_number |
string |
Phone number of a rider in E.164 (international) format. |
guest.locale |
string |
The locale the rider was created in. Defaults to en. |
is_reserve |
bool |
Denotes whether the trip is an Uber Reserve trip. |
location |
object |
Location is only available if request status is accepted or arriving. Not available while the trip is in progress. |
location.latitude |
float |
The current latitude of the vehicle. |
location.longitude |
float |
The current longitude of the vehicle. |
location.bearing |
float |
The current bearing of the vehicle in degrees (0-359). |
location_uuid |
string |
The UUID of the Uber for Business organization that requested the ride. |
note_for_driver |
string |
A free text field for a coordinator to enter a message that will be sent to the driver once the driver gets assigned to a trip. |
pickup.address |
string |
The pickup location’s complete address. |
pickup.eta |
int |
The estimated time in minutes until arrival at the pickup. Only available when the trip state is accepted or arriving. |
pickup.latitude |
float |
The latitude of the pickup location. |
pickup.longitude |
float |
The longitude of the pickup location. |
pickup.place.place_id |
string |
The place ID in provider’s namespace. |
pickup.place.provider |
string |
The provider name. |
pickup.subtitle |
string |
The pickup location city and state, where applicable. |
pickup.timezone |
string |
The timezone at pickup address. |
pickup.title |
string |
The pickup location street address. |
policy_uuid |
string |
ID of object that contains permission and product type. |
product.product_id |
string |
The ID returned from the products endpoint. |
product.display_name |
string |
The type of Uber product (ex: UberX). |
request_id |
string |
The unique ID of the trip request. |
request_time |
int |
The time in milliseconds the request was made. |
requester_name |
string |
The name of the user that requested the trip. |
requester_uuid |
string |
The UUID of the user that requested the trip. |
scheduling |
object |
The root scheduling object of the trip. Only available if trip is scheduled. |
scheduling.pickup_time |
int |
A timestamp in milliseconds of when the trip is scheduled. Only set for scheduled rides. |
status |
string |
The status of the trip request indicating state. |
status_detail |
string |
More detail about the status, this field is only populated for rider_canceled status, and it helps to differentiate when trip was canceled by the Coordinator (coordinator_canceled) or the Rider (guest_rider_canceled). |
surge_multiplier |
float |
The surge pricing multiplier used to calculate the increased price of a trip request. A multiplier of 1.0 means surge pricing is not in effect. |
trip_distance_miles |
float |
The trip distance, in miles. |
trip_duration_seconds |
int |
The trip duration, in seconds. |
trip_end_location |
object |
The location of the driver when they ended the trip. Only available for completed trips. |
trip_end_location.latitude |
float |
The latitude of the trip’s end location. |
trip_end_location.longitude |
float |
The longitude of the trip’s end location. |
trip_end_location.address |
string |
The end location’s complete address. |
trip_end_location.place.place_id |
string |
The place ID in provider’s namespace. |
trip_end_location.place.provider |
string |
The name of a provider of location data, e.g. google_places. |
trip_end_location.place.subtitle |
string |
The end location city and state, where applicable. |
trip_end_location.place.title |
string |
The end location street address. |
vehicle |
object |
The root vehicle object of the trip. Not available before a driver is dispatched. |
vehicle.color_name |
string |
The color of the driver’s vehicle. |
vehicle.license_plate |
string |
The vehicle’s license plate number. |
vehicle.make |
string |
The make of the driver’s vehicle. |
vehicle.model |
string |
The model of the driver’s vehicle. |
vehicle.picture_url |
string |
The URL to the photo of the vehicle. |
waypoints |
array |
An array of waypoints (either “pickup or dropoff”) for the trip. Only set on trips in a terminal state. |
waypoints.latitude |
float |
The latitude in the waypoint being referenced. |
waypoints.longitude |
float |
The longitude in the waypoint being referenced. |
waypoints.type |
string |
The type of waypoint, either “pickup” or “dropoff”. |
rider_tracking_url |
string |
The URL to track ride when the trip is in accepted and in progress state. |
editable_fields[FIELD_ID] |
object |
Specifies the fields in a trip that can be updated. Each field is identified by a FIELD_ID . |
¶ editable_fields
details
FIELD_ID | Name | Type | Description |
---|---|---|---|
PICKUP |
editable |
bool |
Specifies if the Pickup is editable in the current trip status. |
PICKUP |
max_radius_meters |
bool |
Specifies from the original pickup point within which a location field can be updated. |
DROPOFF |
editable |
bool |
Specifies if the Dropoff is editable in the current trip status. |
STOPS |
editable |
bool |
Specifies if the Stops is editable in the current trip status. |
Editable fields format example
"editable_fields": {
"PICKUP": {
"editable": false,
"max_radius_meters": 200
},
"STOPS": {
"editable": false
},
"DROPOFF": {
"editable": false
}
}
¶ Trip request status
values
All possible status values of Request life cycle.
status |
Description |
---|---|
processing | The request is matching to the most efficient available driver. |
no_drivers_available | The request was unfulfilled because no drivers were available. |
accepted | The request has been accepted by a driver and is “en route” to the start location (i.e. start_latitude and start_longitude). |
arriving | The driver has arrived or will be shortly. |
in_progress | The request is “en route” from the start location to the end location. |
driver_canceled | The request has been canceled by the driver. |
rider_canceled | The request canceled by rider. |
completed | The request has been completed by the driver. |
scheduled | The request is scheduled to be dispatched at a later time. |
failed | The request failed. |
offered | The deferred ride is actively redeemable by a rider. |
expired | The deferred ride has expired and cannot be redeemed by the rider. |
driver_redispatched | The driver is resipatched and the driver should be arriving shortly. |
¶ Trip request status_detail
values
All possible status_detail
values for a request with rider_canceled
status.
Status | Description |
---|---|
coordinator_canceled | The request was canceled by the Coordinator. |
guest_rider_canceled | The request was canceled by the Rider. |
Use case
Authorization
Request
Example request
Request URL path parameters
Request Query parameters
Response
Example accepted trip response with editable_fields
Example in_progress trip response
Example completed trip response
trips item parameters
editable_fields details
Trip request status values
Trip request status_detail values