Drivers - Retrieve All Drivers

Overview

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

---

Request

GET /v1/accounts/{account_uuid}/drivers

Query Parameters

Parameter	Type	Description
invited_drivers	Boolean	Optional. If set to true, the response will include drivers who have been invited but not yet signed up.

Example Request

GET /v1/accounts/3584a197b5a9/drivers?invited_drivers=true

---

Response

Response Values

Key	Type	Value
account_uuid	String	Driver's Unique Account Identifier
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
invitation_phone_number	String	The phone number used to invite the driver
invitation_email	String	The email address used to invite the driver
signup_completed	Boolean	Indicates if the driver completed the signup process. Only present if invited_drivers=true is set.

Example Response

Note: The following example shows the response when the invited_drivers=true query parameter is used.

[
  {
    "account_uuid": "100000ben1es",
    "uuid": "54f5b7b86e9f",
    "partners_external_identifier": "POS2-4564",
    "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",
    "invitation_phone_number": "+447455644555",
    "invitation_email": "john.smith@captain.ai",
    "signup_completed": true
  },
  {
    "account_uuid": "100000ben1es",
    "uuid": "62d4c15f21a",
    "partners_external_identifier": "POS2-4564",
    "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",
    "invitation_phone_number": "+447455644550",
    "invitation_email": "jake.smith@captain.ai",
    "signup_completed": true
  }
]