The Fleet object

{
  "id": null,
  "object": null,
  "address": {
    "city": null,
    "country": null,
    "line1": null,
    "line2": null,
    "postal_code": null,
    "state": null
  },
  "created": null,
  "description": null,
  "email": null,
  "metric_system": null,
  "name": null,
  "phone": null,
  "preferences": {
    "billing_cycle": null,
    "notifications": null,
    "default_currency": null,
    "default_payment_method": null,
    "report_frequency": null
  },
  "status": null,
  "timezone": null,
  "total_drivers": null,
  "total_vehicles": null,
  "total_energy_consumed_kwh": null,
  "total_sessions": null,
  "updated": null,
  "wallet_balance": null
}

string

Unique identifier for the fleet object.

Example:

null

object

string

String representing the object’s type. Always fleet.

Example:

null

address

object

Physical address associated with the fleet’s headquarters or billing location.

Show child attributes

created

integer

Time at which the fleet was created (UNIX timestamp).

Example:

null

description

string | null

Optional internal description of the fleet.

Example:

null

string | null

Contact email associated with the fleet.

Example:

null

metric_system

enum<string>

Unit system preferred for reports and distance/energy formats.

Available options:

international_system,

us_customary_system,

imperial_system

Example:

null

name

string

Human-readable name of the fleet.

Example:

null

phone

string | null

Optional phone number associated with the fleet.

Example:

null

preferences

object

Account-level settings related to billing, reporting, and charging activity.

Show child attributes

status

enum<string>

Current operational status of the fleet.

Available options:

active,

suspended,

archived

Example:

null

timezone

string

IANA timezone identifier used for reporting and scheduling (e.g., Etc/UTC).

Example:

null

total_drivers

integer

Number of drivers currently assigned to this fleet.

Example:

null

total_vehicles

integer

Number of vehicles currently assigned to this fleet.

Example:

null

total_energy_consumed_kwh

number

Total historical energy consumed by the fleet across all sessions (in kWh).

Example:

null

total_sessions

integer

Total number of charging sessions completed by the fleet.

Example:

null

updated

integer

Time at which the fleet object was last updated.

Example:

null

wallet_balance

integer

Fleet's current wallet or prepaid balance in the smallest currency unit (e.g., cents).

Example:

null

Retrieve an estimation Create a fleet

⌘I

About Us

API Reference

The Fleet object