OpenAPI reference

Sender Session

GET/sessions

Fetch Sessions from a CPO system.

API: OCPI 2.1.1 (CPO) · Module: Sessions (CPO)
Base path: /sessions · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1

Overview

GET /sessions

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/sessions

Fetch Sessions from a CPO system.

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/sessions?date_from=2025-01-01T00%3A00%3A00Z&date_to=2025-01-01T00%3A00%3A00Z&offset=0&limit=50' \
2  -H "Authorization: Token $OCPI_TOKEN"

Request

Query parameters

Name	Type	Required	Description
`date_from`	`string (date-time)`	No	Only return objects with last_updated after this DateTime (inclusive).
`date_to`	`string (date-time)`	No	Only return objects with last_updated before this DateTime (exclusive).
`offset`	`integer`	No	The offset of the first object returned. Default is 0.
`limit`	`integer`	No	Maximum number of objects to GET.

Responses

Status	Description	Schema
`200`	Successful Response	`SessionsResponse`
`401`	Unauthorized	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: SessionsResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`SessionOut[]`	No	`Data`. Default: `[]`

Response example

1{
2  "data": [
3    {
4      "auth_id": "DE8ACC12E46L89",
5      "auth_method": "WHITELIST",
6      "authorization_id": "DE8ACC12E46L89",
7      "charging_periods": [
8        {
9          "dimensions": [
10            {
11              "type": "ENERGY",
12              "volume": 41
13            }
14          ],
15          "start_date_time": "2015-06-29T22:39:09Z"
16        }
17      ],
18      "currency": "EUR",
19      "end_datetime": "2015-06-29T23:50:16Z",
20      "id": "101",
21      "kwh": 41,
22      "last_updated": "2015-06-29T23:50:16Z",
23      "location": {
24        "address": "F.Rooseveltlaan 3A",
25        "city": "Gent",
26        "coordinates": {
27          "latitude": "51.047599",
28          "longitude": "3.729944"
29        },
30        "country": "BEL",
31        "evses": [
32          {
33            "connectors": [
34              {
35                "amperage": 64,
36                "format": "SOCKET",
37                "id": "1",
38                "last_updated": "2015-06-29T23:09:10Z",
39                "power_type": "AC_1_PHASE",
40                "standard": "IEC_62196_T2",
41                "tariff_id": "11",
42                "voltage": 230
43              }
44            ],
45            "evse_id": "BE-BEC-E041503003",
46            "last_updated": "2015-06-29T23:09:10Z",
47            "status": "AVAILABLE",
48            "uid": "3256"
49          }
50        ],
51        "id": "LOC1",
52        "last_updated": "2015-06-29T23:09:10Z",
53        "name": "Gent Zuid",
54        "postal_code": "9000",
55        "type": "ON_STREET"
56      },
57      "meter_id": "METER-001",
58      "start_datetime": "2015-06-29T22:39:09Z",
59      "status": "ACTIVE",
60      "total_cost": 10
61    }
62  ],
63  "status_code": 1000,
64  "status_message": "Success",
65  "timestamp": "2015-06-29T22:39:09Z"
66}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2000,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/sessions?date_from=2025-01-01T00%3A00%3A00Z&date_to=2025-01-01T00%3A00%3A00Z&offset=0&limit=50' \
2  -H "Authorization: Token $OCPI_TOKEN"

OpenAPI reference

Sender Session

GET/sessions

Fetch Sessions from a CPO system.

API: OCPI 2.1.1 (CPO) · Module: Sessions (CPO)
Base path: /sessions · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1

Overview

GET /sessions

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/sessions

Fetch Sessions from a CPO system.

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/sessions?date_from=2025-01-01T00%3A00%3A00Z&date_to=2025-01-01T00%3A00%3A00Z&offset=0&limit=50' \
2  -H "Authorization: Token $OCPI_TOKEN"

Request

Query parameters

Name	Type	Required	Description
`date_from`	`string (date-time)`	No	Only return objects with last_updated after this DateTime (inclusive).
`date_to`	`string (date-time)`	No	Only return objects with last_updated before this DateTime (exclusive).
`offset`	`integer`	No	The offset of the first object returned. Default is 0.
`limit`	`integer`	No	Maximum number of objects to GET.

Responses

Status	Description	Schema
`200`	Successful Response	`SessionsResponse`
`401`	Unauthorized	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: SessionsResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`SessionOut[]`	No	`Data`. Default: `[]`

Response example

1{
2  "data": [
3    {
4      "auth_id": "DE8ACC12E46L89",
5      "auth_method": "WHITELIST",
6      "authorization_id": "DE8ACC12E46L89",
7      "charging_periods": [
8        {
9          "dimensions": [
10            {
11              "type": "ENERGY",
12              "volume": 41
13            }
14          ],
15          "start_date_time": "2015-06-29T22:39:09Z"
16        }
17      ],
18      "currency": "EUR",
19      "end_datetime": "2015-06-29T23:50:16Z",
20      "id": "101",
21      "kwh": 41,
22      "last_updated": "2015-06-29T23:50:16Z",
23      "location": {
24        "address": "F.Rooseveltlaan 3A",
25        "city": "Gent",
26        "coordinates": {
27          "latitude": "51.047599",
28          "longitude": "3.729944"
29        },
30        "country": "BEL",
31        "evses": [
32          {
33            "connectors": [
34              {
35                "amperage": 64,
36                "format": "SOCKET",
37                "id": "1",
38                "last_updated": "2015-06-29T23:09:10Z",
39                "power_type": "AC_1_PHASE",
40                "standard": "IEC_62196_T2",
41                "tariff_id": "11",
42                "voltage": 230
43              }
44            ],
45            "evse_id": "BE-BEC-E041503003",
46            "last_updated": "2015-06-29T23:09:10Z",
47            "status": "AVAILABLE",
48            "uid": "3256"
49          }
50        ],
51        "id": "LOC1",
52        "last_updated": "2015-06-29T23:09:10Z",
53        "name": "Gent Zuid",
54        "postal_code": "9000",
55        "type": "ON_STREET"
56      },
57      "meter_id": "METER-001",
58      "start_datetime": "2015-06-29T22:39:09Z",
59      "status": "ACTIVE",
60      "total_cost": 10
61    }
62  ],
63  "status_code": 1000,
64  "status_message": "Success",
65  "timestamp": "2015-06-29T22:39:09Z"
66}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2000,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/sessions?date_from=2025-01-01T00%3A00%3A00Z&date_to=2025-01-01T00%3A00%3A00Z&offset=0&limit=50' \
2  -H "Authorization: Token $OCPI_TOKEN"

Sender Session

Overview

How to call

Request

Query parameters

Responses

`200` — successful response

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Sender Session

Overview

How to call

Request

Query parameters

Responses

`200` — successful response

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page