Uber Developers

List All Health Trips

GEThttps://api.uber.com/v1/health/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

List all the active and/or past trips for an organization

¶ Authorization

OAuth 2.0 Bearer token with the health scope.

¶ Example Request

Try It Replace the token in the below request to use it a terminal to see current and past trips.

curl -X GET \
  -H "authorization: Bearer $UBER_TOKEN" \
  'https://sandbox-api.uber.com/v1/health/trips?limit=10'

¶ Query Params

Name	Type	Description
`limit`	`int`	(optional) The maximum number of trips that appear per page. (Default 50)
`start_key`	`string`	(optional) Key used for requesting a specific page for a list of trips. The `next_key` in the response is used to retrieve the next page. Defaults to the most recent trips.
`trip_status`	`string`	(optional) A ride status to filter the response by {ACTIVE, PAST}. Optional, if not specified will default to ACTIVE trips.
`include_editable_fields`	`bool`	(optional) When set to true, this option includes editable fields in the response. If omitted or set to false, editable fields are excluded.

¶ Example Response

{
  "trips": [
    {
      "guest": {
        "email": "joe@example.com",
        "first_name": "Joe",
        "guest_id": "OVmNxPG1ENYSwn8QonwLapF3ZJl2KJipkUc0AP3C74U=",
        "last_name": "Example",
        "phone_number": "+15551234567"
      },
      "destination": {
        "latitude": 37.789,
        "longitude": -122.4
      },
      "pickup": {
        "eta": 5,
        "latitude": 37.776,
        "longitude": -122.417
      },
      "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"
        }
      },
      "location": {
        "bearing": 5,
        "latitude": 37.776,
        "longitude": -122.417
      },
      "status": "processing",
      "request_time": 1504809023000,
      "begin_trip_time": null,
      "dropoff_time": null
    }
  ]
}

¶ Example Response with editable fields

{
  "trips": [
    {
      "guest": {
        "email": "joe@example.com",
        "first_name": "Joe",
        "guest_id": "OVmNxPG1ENYSwn8QonwLapF3ZJl2KJipkUc0AP3C74U=",
        "last_name": "Example",
        "phone_number": "+15551234567"
      },
      "destination": {
        "latitude": 37.789,
        "longitude": -122.4
      },
      "pickup": {
        "eta": 5,
        "latitude": 37.776,
        "longitude": -122.417
      },
      "driver": null,
      "location": {
        "bearing": 5,
        "latitude": 37.776,
        "longitude": -122.417
      },
      "status": "processing",
      "request_time": 1504809023000,
      "begin_trip_time": null,
      "dropoff_time": null,
      "editable_fields": {
          "PICKUP": {
              "editable": false,
              "maxRadius": 200
          },
          "STOPS": {
              "editable": false
          },
          "DROPOFF": {
             "editable": false
          }
      }
    }
  ]
}

Name	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`	`object`	Root object containing a list of trips. See the object definition in GET /v1/health/trips/{}