Sites
GET /api/sites
Retrieve a list of an organization's sites, chargers, and ports, as well as their most recent status and details about any ongoing charging sessions.
This endpoint has no parameters, and returns all sites, chargers, and ports each time.
Response
The JSON response will contain a data field, which represents a nested list of sites, chargers, and charging ports.
{
data: {
id: number;
name: string;
address: string | null;
timezone: string; // IANA format
organization: {
id: number;
name: string;
},
chargers: {
id: number;
name: string;
manufacturer: string | null;
model: string | null;
serialNumber: string | null;
firmwareVersion: string | null;
latitude: number | null;
longitude: number | null;
externalId: string | null;
ocppId: string | null;
type: string; // One of: "DCFC", "Level 2"
powerSharing: boolean; // true if the charger has more than one port (power-sharing enabled)
// null if the charger has never connected to Flipturn
connectionStatus: {
status: string; // e.g. "Connected", "Disconnected"
timestamp: string; // ISO 8601 format
} | null;
numberOfPorts: number;
ports: {
id: number;
name: string;
portNumber: number;
maximumPowerKw: number | null;
// CCS1, J1772, or NACS
connectorType: string;
// null if the port has never sent an OCPP status
ocppStatus: {
status: string; // e.g. "Available", "Charging", "Faulted"
timestamp: string; // ISO 8601 format
errorCode: string; // OCPP error code, e.g. "NoError", "ConnectorLockFailure"
vendorErrorCode: string | null; // Vendor-specific error code
info: string | null; // Additional error information
} | null;
// Information about any ongoing charging session -- will be null if no charging session is
// currently happening on this charger
currentChargingSession: {
id: number;
startTime: string; // ISO 8601 format
socStartPercent: number | null;
energyDeliveredKwh: number;
ocppIdTag: string | null;
ocppTransactionId: number | null;
// Latest meter readings from the charging session
latestReadings: {
powerKw: {
value: number;
timestamp: string; // ISO 8601 format
} | null;
currentA: {
value: number;
timestamp: string; // ISO 8601 format
} | null;
socPercent: {
value: number;
timestamp: string; // ISO 8601 format
} | null;
voltage: {
value: number;
timestamp: string; // ISO 8601 format
} | null;
};
vehicle: {
id: number;
make: string | null;
model: string | null;
name: string;
vin: string | null;
} | null;
rfid: {
id: number;
name: string | null;
} | null;
customer: {
name: string;
} | null;
} | null;
}[];
}[];
}[];
}Example request and response
Request:
Response:
Last updated