List Chargers

GET /v3/sites/{site}/chargers

List Chargers

cURL

curl --request GET \
  --url https://app.plugchoice.com/api/v3/sites/{site}/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,
  "licenses": {
    "smart": true,
    "pro": true
  },
  "connectors": [
    {
      "id": 123,
      "charger_id": 123,
      "connector_id": 123,
      "status": "<string>",
      "max_amperage": 123,
      "max_voltage": 123,
      "standard": "<string>",
      "format": "<string>",
      "power_type": "<string>",
      "phase_rotation": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Returns a paginated list of chargers assigned to the specified location. Includes connector information for each charger. Results are paginated with 25 items per page.

site · string · required

The UUID of the location.

Response

uuid · string

The unique UUID of the charger.

id · integer

The numeric ID of the charger.

identity · string

The charger’s OCPP identity string.

reference · string

A custom reference label for the charger.

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.

error_info · string

Additional error information, if any.

vendor_id · string

The vendor identifier.

vendor_error_code · string

The vendor-specific error code, if any.

firmware_version · string

The charger’s firmware version string.

parsed_firmware_version · string

The parsed firmware version, or null if unparseable.

server · string

The OCPP server the charger is connected to.

last_connection_at · string

ISO 8601 timestamp of the last connection.

last_disconnection_at · string

ISO 8601 timestamp of the last disconnection.

last_heartbeat_at · string

ISO 8601 timestamp of the last heartbeat.

setup_pending · boolean

Whether the charger has a pending setup.

setup_completed · boolean

Whether the charger setup is completed.

blocked · boolean

Whether the charger is blocked.

max_current · integer

The maximum current in amps.

licenses · object

The charger’s active licenses.

Show licenses

smart · boolean

Whether the smart license is active.

pro · boolean

Whether the pro license is active.

connectors · array

An array of connector objects for this charger.

Show connector object

id · integer

The numeric ID of the connector.

charger_id · integer

The ID of the parent charger.

connector_id · integer

The OCPP connector ID.

status · string

The current connector status.

max_amperage · integer

The maximum amperage of the connector.

max_voltage · integer

The maximum voltage of the connector.

standard · string

The connector standard (e.g., IEC 62196).

format · string

The connector format (e.g., Socket, Cable).

power_type · string

The power type (e.g., AC_1_PHASE, AC_3_PHASE, DC).

phase_rotation · string

The phase rotation configuration.

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.