List Chargers

GET

/tenant/{tenantId}/charger

const url = 'https://api.exolink.cloud/tenant/example/charger';
const options = {
  method: 'GET',
  headers: {
    'x-exo-fields': '["id","displayName"]',
    'x-exo-filter': '["eq","profileId",3]',
    'x-exo-sort': '["asc","displayName"]',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.exolink.cloud/tenant/example/charger \
  --header 'Authorization: Bearer <token>' \
  --header 'x-exo-fields: ["id","displayName"]' \
  --header 'x-exo-filter: ["eq","profileId",3]' \
  --header 'x-exo-sort: ["asc","displayName"]'

Return the list of chargers for the given tenant, 500 per page unless x-exo-size says otherwise. x-exo-sort also accepts chargerConnected and cpmsConnected; chargers of unknown connection state sort last.

Send Content-Type: text/csv to receive CSV. Without x-exo-size the CSV holds every charger.

Authorizations

bearerToken

Parameters

Path Parameters

tenantId

required

string

Tenant domain prefix

Header Parameters

x-exo-fields

string

JSON array of the fields to return

Example

["id","displayName"]

x-exo-filter

string

JSON filter expression [operator, field, value]. Operators: eq, ne, gt, gte, lt, lte, in, nin, like, ilike, nlike, nilike, null, nnull, and eqc, nec, gtc, gtec, ltc, ltec to compare two fields. Combine expressions with ["and", ...] or ["or", ...].

Example

["eq","profileId",3]

x-exo-page

integer

>= 1

Page number, starting at 1. Applies together with x-exo-size.

x-exo-size

integer

>= 1

Page size. Every returned row then carries __total, the number of matching rows.

x-exo-sort

string

JSON sort [direction, field] with direction asc or desc, or a list of them

Example

["asc","displayName"]

Responses

200

List of chargers

Array<object>

object

Unique identifier for the charger

integer

tenantId

ID of the tenant that owns this charger

integer

profileId

ID of the configuration profile associated with this charger

integer

displayName

User-friendly name for the charger

string

nullable

provisioned

Indicates whether the charger has been discovered and configured

boolean

identity

Unique identity string used for OCPP communication

string

chargeBoxSerialNumber

Serial number of the charge box hardware

string

nullable

chargePointSerialNumber

Serial number of the charge point

string

nullable

meterSerialNumber

Serial number of the integrated energy meter

string

nullable

chargePointModel

Model identifier of the charge point

string

chargePointVendor

Manufacturer or vendor of the charge point

string

firmwareVersion

Current firmware version running on the charger

string

nullable

iccid

Integrated Circuit Card Identifier for the SIM card (if applicable)

string

nullable

imsi

International Mobile Subscriber Identity for cellular connectivity (if applicable)

string

nullable

meterType

Type or model of the energy meter

string

nullable

status

Current operational status of the charger; empty when not blocked

string

Allowed values: BLOCKED ""

aliases

Identity the charger has on a CPMS, keyed by CPMS ID

object

key

additional properties

string

createdAt

Timestamp when the charger record was created

string

updatedAt

Timestamp when the charger record was last updated

string

deletedAt

Timestamp when the charger record was soft-deleted (null if active)

string

nullable

profileName

Name of the configuration profile associated with this charger

string

chargerConnected

Indicates whether the charger is currently connected to the platform; null when unknown

boolean

nullable

cpmsConnected

Indicates whether the charger is currently connected to the CPMS backend; null when unknown

boolean

nullable

connectedCpmsIds

IDs of the CPMS backends the charger is currently connected to; null when unknown

Array<string>

nullable

cpmsName

Name(s) of the CPMS backend(s) this charger is connected to

string

cpmsUrl

WebSocket URL(s) of the CPMS backend(s) this charger is connected to

string

Examples

List of chargers

[
  {
    "id": 4,
    "tenantId": 1,
    "profileId": 3,
    "displayName": "Test",
    "provisioned": false,
    "identity": "TEST",
    "chargeBoxSerialNumber": null,
    "chargePointSerialNumber": null,
    "meterSerialNumber": null,
    "chargePointModel": "Unknown",
    "chargePointVendor": "Unknown",
    "firmwareVersion": null,
    "iccid": null,
    "imsi": null,
    "meterType": null,
    "status": "",
    "aliases": {},
    "createdAt": "2025-10-15T15:19:50.834Z",
    "updatedAt": "2025-10-15T15:19:50.834Z",
    "deletedAt": null,
    "profileName": "Main Profile",
    "chargerConnected": null,
    "cpmsConnected": null,
    "connectedCpmsIds": null,
    "cpmsName": "My CPMS",
    "cpmsUrl": "ws://cpms.example.com"
  }
]

401

Missing, invalid or expired credentials

application/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Not authorized",
  "errorCode": "ERR_API_NOT_AUTHORIZED"
}

403

The caller may not perform this action

application/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Forbidden",
  "errorCode": "ERR_API_FORBIDDEN"
}