List Chargers

GET /v3/chargers

List Chargers

cURL

curl --request GET \
  --url https://app.plugchoice.com/api/v3/chargers \
  --header 'Authorization: Bearer <token>'

200

{
  "uuid": "<string>",
  "id": 123,
  "identity": "<string>",
  "reference": "<string>",
  "connection_status": "<string>",
  "status": "<string>",
  "error": "<string>",
  "error_info": "<string>",
  "vendor_id": "<string>",
  "vendor_error_code": "<string>",
  "firmware_version": "<string>",
  "parsed_firmware_version": "<string>",
  "server": "<string>",
  "last_connection_at": "<string>",
  "last_disconnection_at": "<string>",
  "last_heartbeat_at": "<string>",
  "setup_pending": true,
  "setup_completed": true,
  "blocked": true,
  "max_current": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "licenses": {
    "smart": true,
    "pro": true
  },
  "model_id": 123,
  "model": {
    "vendor": "<string>",
    "name": "<string>",
    "is_dc": true
  },
  "permissions": {
    "basic": true,
    "sensitive": true,
    "full": true
  }
}

Returns a paginated list of chargers accessible to the authenticated user. Each charger includes its associated model.

Response

uuid · string

The unique UUID of the charger.

id · integer

The numeric ID of the charger.

identity · string

The unique identity string of the charger (e.g., serial number).

reference · string

A user-defined reference or label for the charger. May be null.

connection_status · string

The current connection status of the charger.

status · string

The current OCPP status of the charger.

error · string

The current error code, if any. May be null.

error_info · string

Additional error information. May be null.

vendor_id · string

The vendor identifier. May be null.

vendor_error_code · string

A vendor-specific error code. May be null.

firmware_version · string

The raw firmware version string. May be null.

parsed_firmware_version · string

The parsed and normalized firmware version. May be null.

server · string

The OCPP server the charger is connected to. May be null.

last_connection_at · string

ISO 8601 timestamp of the last connection. May be null.

last_disconnection_at · string

ISO 8601 timestamp of the last disconnection. May be null.

last_heartbeat_at · string

ISO 8601 timestamp of the last heartbeat. May be null.

setup_pending · boolean

Whether the charger has a pending setup operation.

setup_completed · boolean

Whether the charger has completed initial setup.

blocked · boolean

Whether the charger is blocked.

max_current · number

The maximum current in Amperes the charger can deliver.

created_at · string

ISO 8601 timestamp of when the charger was created.

updated_at · string

ISO 8601 timestamp of when the charger was last updated.

licenses · object

The charger’s active licenses.

Show licenses

smart · boolean

Whether the smart charging license is active.

pro · boolean

Whether the pro license is active.

model_id · integer

The ID of the charger model. May be null.

model · object

The charger model details. Only included when the model relationship is loaded.

Show model

vendor · string

The vendor or manufacturer name.

name · string

The model name.

is_dc · boolean

Whether this is a DC charger.

permissions · object

The authenticated user’s permissions for this charger.

Show permissions

basic · boolean

Whether the user has basic read access.

sensitive · boolean

Whether the user has access to sensitive data (e.g., pincode, transactions).

full · boolean

Whether the user has full control (e.g., delete, transfer).