Skip to content

Get charger​

GET
/chargers/{chargerId}

Returns the charger record, including its current status, configuration, connection details, metadata, and connectors.

Use cases

  • Inspect connectivity or connector status while troubleshooting.
  • Read the current configuration before changing a setting.

Related endpoints

  • PATCH /chargers/{chargerId} — update charger metadata.
  • POST /chargers/{chargerId}/configuration/set — change an OCPP configuration value.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Path Parameters

chargerId*

UUID returned by POST /chargers or GET /chargers. Use it to target that charger for configuration, connector, or status operations.

Type
string
Required
Example"550e8400-e29b-41d4-a716-446655440000"
Min Length
1
Max Length
40

Responses​

success.charger.get

application/json

Playground​

Authorization
Headers
Variables
Key
Value

Samples​