GET
/
drivers
List drivers
curl --request GET \
  --url https://api.chargeapi.co/v1/drivers \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "object": "list",
  "data": [
    {
      "id": null,
      "object": null,
      "created": null,
      "email": null,
      "fleets": null,
      "license_number": null,
      "name": null,
      "phone": null,
      "preferences": {
        "charging_speed": null,
        "currency": null,
        "default_payment_method": null,
        "max_price_per_kwh": null,
        "notifications": null,
        "preferred_charging_stations": null,
        "preferred_cpos": null
      },
      "status": null,
      "updated": null,
      "vehicles": null,
      "wallet_balance": null
    }
  ],
  "has_more": true,
  "url": "<string>"
}

Query Parameters

​
ending_before
string

A cursor for pagination. Returns objects listed before the given ID.

​
expand
string[]

Specifies which fields in each driver object to expand.

​
fleet
string

Limit results to drivers attached to this fleet. Cannot be combined with vehicle.

​
limit
integer

Number of objects to return (default 10, max 100).

Required range: 1 <= x <= 100
​
starting_after
string

A cursor for pagination. Returns objects listed after the given ID.

​
vehicle
string

Limit results to drivers attached to this vehicle. Cannot be combined with fleet.

Body

application/json · object

Response

A dictionary with a data property that contains an array of up to limit Driver objects, starting after Driver starting_after. Each entry in data is a separate Driver object. If no additional drivers are available, the array is empty.

The response is of type object.