List rides - Lyft

Get a list of past & current rides for this passenger.

{ "ride_history": [ { "beacon_color": "#FFFFFF", "destination": { "address": "987 Second St, Anytown, CA", "lat": 36.9453452, "lng": -123.8642521 }, "distance_miles": 16.2, "driver": { "first_name": "Joe", "image_url": "http://example.com/lyft.png", "phone_number": "+15554445111", "rating": "4.9" }, "dropoff": { "address": "987 Second St, Anytown, CA", "lat": 36.9453452, "lng": -123.8642521, "time": "2023-08-15T05:38:32.975Z" }, "duration_seconds": 1620, "line_items": [ { "amount": 500, "currency": "USD", "type": "Ride" }, { "amount": 250, "currency": "USD", "type": "Prime Time" }, { "amount": 155, "currency": "USD", "type": "Service fee" } ], "location": { "address": "987 Second St, Anytown, CA", "lat": 36.9453452, "lng": -123.8642521 }, "origin": { "address": "123 Main St, Anytown, CA", "lat": 36.9442175, "lng": -123.8679133 }, "passenger": { "first_name": "Jane", "phone_number": "+15554445000", "user_id": "776630198662493392" }, "pickup": { "address": "123 Main St, Anytown, CA", "lat": 36.9442175, "lng": -123.8679133, "time": "2023-08-15T05:38:32.975Z" }, "price": { "amount": 905, "currency": "USD", "description": "Total ride price" }, "primetime_percentage": "50%", "requested_at": "2023-08-15T05:38:32.975Z", "ride_id": 123456789, "ride_profile": "personal", "ride_type": "lyft", "status": "droppedOff", "vehicle": { "color": "black", "image_url": "http://example.com/lyft.png", "license_plate": "AAAAAAA", "make": "Audi", "model": "A4" } } ] }

Request

Query Params

start_time

string

required

Restrict to rides starting after this point in time. The earliest supported date is 2015-01-01T00:00:00+00:00

end_time

string

optional

Restrict to rides starting before this point in time. The earliest supported date is 2015-01-01T00:00:00+00:00

limit

integer

optional

The maximum number of rides to return. The default limit is 10 if not specified. The maximum allowed value is 50, an integer greater that 50 will return at most 50 results.

Responses

🟢200An object with an array of up to `limit` rides taken by the user between `start_time` and `end_time`.

application/json

Body

ride_history

array[object (RideDetail) {27}]

optional

beacon_color

string

optional

Hex color code of the driver AMP device.

can_cancel

array[string]

optional

Allowed values:

driverpassengerdispatcher

canceled_by

string

optional

The role of user who canceled the ride (if applicable)

cancellation_price

object | allOf {1}

optional

The cost of cancellation if there would be a penalty

destination

object | allOf {1}

optional

The requested location for passenger drop off

distance_miles

number <float>

optional

The distance, in miles, that this ride traveled. This field is only present after drop-off

driver

object (DriverDetail)

optional

Example:

{"first_name":"Joe","image_url":"http://example.com/lyft.png","phone_number":"+15554445000","rating":"4.9","user_id":"123456789"}

dropoff

object | allOf {1}

optional

The actual location of passenger drop off

duration_seconds

integer <int32>

optional

Duration of the ride in seconds from pickup to drop-off. This field is only present after drop-off.

feedback

string

optional

The written feedback the user left for this ride

generated_at

string <date-time>

optional

The request timestamp in date and time

line_items

array[object (LineItem) {3}]

optional

The break down of cost

location

object | allOf {1}

optional

The current location info of the ride

origin

object | allOf {1}

optional

The requested location for passenger pickup

passenger

object (PassengerDetail)

optional

Example:

null

pickup

object | allOf {1}

optional

The actual location of passenger pickup

price

object | allOf {1}

optional

The total price for the current ride

pricing_details_url

string

optional

The web view showing the pricing structure for the geographic area where the ride was taken

primetime_percentage

string

optional

The Prime Time percentage applied to the base price

rating

integer <int32>

optional

The rating the user left for this ride, from 1 to 5

requested_at

string <date-time>

optional

The ride requested timestamp in date and time

ride_id

string

optional

The unique ID of this ride

ride_profile

object | allOf {1}

optional

Indicates whether the ride was requested from the business profile or personal profile of the user.

ride_type

enum<string>

optional

The ID of the ride type

Allowed values:

lyftlyft_linelyft_pluslyft_premierlyft_luxlyft_luxsuvother

route_url

string

optional

The web view showing the passenger, driver, and route for this ride. This field will only be present for rides created through this API, or that have been shared through the "Share my Route" feature

status

enum<string>

optional

The status of the ride

Allowed values:

pendingacceptedarrivedpickedUpdroppedOffcanceledscheduledunknown

vehicle

object (VehicleDetail)

optional

Example:

{"color":"black","image_url":"http://example.com/lyft.png","license_plate":"AAAAAAA","license_plate_state":"CA","make":"Audi","model":"A4","year":2016}

🟠400A validation error occurred