Drivers - Retrieve All Drivers

Overview

This endpoint allows you to retrieve all drivers for a given account.

---

Request

GET /v1/accounts/{account_uuid}/drivers

Example Request

GET /v1/accounts/3584a197b5a9/drivers

---

Response

Response Values

Key	Type	Value
uuid	String	A unique ID for the given driver.
partners_external_identifier	String	External id from partner system to identify the driver
first_name	String	The driver's first name
last_name	String	The driver's last name
email	String	The driver's email address
phone_number	String	The driver's phone number
on_duty	Boolean	Whether or not the driver is currently clocked in.
active	Boolean	Whether or not the driver is still an active member of your fleet
profile_picture_url	String	A link to a photo of the driver
eta_arrive_at_home_hub	Integer	An estimated time (in Unix time) of how long the driver will take to get back to the restaurant (hub)
eta_till_available	Integer	An estimated time (in Unix time) of how soon the driver will become available

Example Response

[
  {
    "account_uuid": "100000ben1es",
    "uuid": "54f5b7b86e9f",
    "partners_external_identifier": "POS2-4564",
    "account_partners_external_identifier": "business.test1.org/establishment/12",
    "account_business_partners_external_identifier": "testing-business-external-id",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@captain.ai",
    "phone_number": "+447455644555",
    "on_duty": false,
    "active": true,
    "profile_picture_url": "http://res.cloudinary.com/captain-ai/image/upload/v1591321862/profile_pictures/gfriipbhndq4g6bbrewd.jpg",
    "eta_till_available": 1588610364,
    "eta_arrive_at_home_hub": 1596163627
  },
  {
    "account_uuid": "100000ben1es",
    "uuid": "62d4c15f21a",
    "partners_external_identifier": "POS2-4564",
    "account_partners_external_identifier": "business.test1.org/establishment/12",
    "account_business_partners_external_identifier": "testing-business-external-id",
    "first_name": "Jake",
    "last_name": "Smith",
    "email": "jake.smith@captain.ai",
    "phone_number": "+447455644550",
    "on_duty": true,
    "active": true,
    "profile_picture_url": "http://res.cloudinary.com/captain-ai/image/upload/v1591321862/profile_pictures/gfriipbhndq4g6bbrewe.jpg",
    "eta_till_available": 1588610364,
    "eta_arrive_at_home_hub": 1596163627
  }
]