GET
/
reservations
curl --request GET \
  --url https://api.chargeapi.co/v1/reservations \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 3
}'
{
  "object": "list",
  "url": "<string>",
  "has_more": true,
  "data": [
    {
      "id": "<string>",
      "object": "reservation",
      "cancellation_policy": {
        "free_until_before": 123,
        "type": "free_cancellation"
      },
      "charging_station": "<string>",
      "confirmed_at": 123,
      "connector_type": [
        "<string>"
      ],
      "created": 123,
      "currency": "<string>",
      "driver": "<string>",
      "earliest_start": 123,
      "failed_reason": "no_available_connectors",
      "ideal_end": 123,
      "ideal_start": 123,
      "latest_end": 123,
      "location": {
        "latitude": 123,
        "longitude": 123,
        "radius": 123
      },
      "metadata": {},
      "payment_method": "<string>",
      "reservation_fee": 123,
      "reserved_end": 123,
      "reserved_start": 123,
      "status": "pending",
      "updated": 123,
      "vehicle": "<string>"
    }
  ]
}

Query Parameters

​
limit
integer

Maximum number of reservations to return (default 10).

Required range: 1 <= x <= 100
​
starting_after
string

Pagination cursor; returns reservations after this ID.

​
ending_before
string

Pagination cursor; returns reservations before this ID.

​
status
enum<string>

Filter reservations by status.

Available options:
pending,
confirmed,
completed,
cancelled,
failed,
expired
​
driver
string

Filter reservations by driver ID.

​
vehicle
string

Filter reservations by vehicle ID.

​
charging_station
string

Filter reservations by charging station ID.

​
expand
string[]

Specifies related objects to expand in each reservation (for example, expand[]=charging_station).

Body

application/json · object

Response

200
application/json

A dictionary with a data property that contains an array of up to limit Reservation objects, starting after Reservation starting_after. Each entry in data is a separate Reservation object. If no additional reservations are available, the array is empty.

The response is of type object.