Get a session

GET

https://api.ocpplab.io/cpo/sessions/:session_id

GET

/cpo/sessions/:session_id

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.cpo.sessions.get({
        session_id: "S-2026-09-30-0001",
    });
}
main();

{
  "id": 3001,
  "session_id": "S-2026-09-30-0001",
  "start_date_time": "2026-09-30T08:00:00Z",
  "kwh": "22.5",
  "cdr_token": {
    "uid": "04A2B3C4D5E6F7",
    "country_code": "NL",
    "party_id": "OCP",
    "type": "RFID",
    "contract_id": "NL-OCP-C12345678-X"
  },
  "auth_method": "WHITELIST",
  "location_id": "LOC-AMS-01",
  "evse_uid": "NL*OCP*E1001*1",
  "connector_id": "1",
  "currency": "EUR",
  "status": "COMPLETED",
  "last_updated": "2026-09-30T09:15:00Z",
  "role": "CPO",
  "origin": "LOCAL",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "country_code": "NL",
  "party_id": "OCP",
  "ocpi_version": "2.2.1",
  "billing_state": "BILLED",
  "created_at": "2026-09-30T08:00:00Z",
  "updated_at": "2026-09-30T09:15:00Z",
  "end_date_time": "2026-09-30T09:15:00Z",
  "charging_periods": [
    {
      "start_date_time": "2026-09-30T08:00:00Z",
      "dimensions": [
        {
          "type": "ENERGY",
          "volume": "22.5"
        }
      ]
    }
  ],
  "total_cost": {
    "excl_vat": "9.20",
    "incl_vat": "11.13"
  },
  "charge_point_id": "CP-AMS-001",
  "billed_cdr_id": "CDR-2026-09-30-0001"
}

One session by OCPI id. If two parties use the same id, pass country_code and party_id (409 otherwise).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

session_idstringRequired1-36 characters

OCPI session id.

Query parameters

country_codestring or nullOptionalformat: "^[A-Z]{2}$"=2 characters

Only this OCPI party country code, e.g. NL.

party_idstring or nullOptionalformat: "^[A-Z0-9]{3}$"=3 characters

Only this OCPI party id, e.g. OCP.

Response

The requested object.

idinteger

session_idstring

start_date_timedatetime

kwhstring

cdr_tokenobject

Token snapshot stored on a session or CDR. Older rows may only have a uid. The other OCPI fields are null until the processor stored them.

auth_methodenum or any

location_idstring

evse_uidstring

connector_idstring

currencystring

statusenum or any

last_updateddatetime

rolestring

originenum or any

organization_idstring

country_codestring

party_idstring

ocpi_versionstring

billing_stateenum or any

created_atdatetime

updated_atdatetime

end_date_timedatetime or nullOptional

authorization_referencestring or nullOptional

meter_idstring or nullOptional

charging_periodslist of objects or nullOptional

total_costobject or nullOptional

charge_point_idstring or nullOptional

billing_errorstring or nullOptional

billed_cdr_idstring or nullOptional

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

504

Gateway Timeout Error