Skip to navigation

List reservations

Your reservations, lowest id first, optionally filtered by location, party, role, origin or status. Pass pagination.end_cursor as after to read the next page.

Authentication

AuthorizationBearer

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

Query parameters

afterstring or nullOptionalformat: "^[0-9]+$"1-20 characters

Cursor: the previous page’s pagination.end_cursor. Omit it for the first page.

limitintegerOptional1-200Defaults to 50

Maximum rows per page (default 50, max 200).

location_idstring or nullOptional1-36 characters
Only rows for this OCPI location.
country_codestring or nullOptionalformat: "^[A-Za-z]{2}$"=2 characters

Only rows of this OCPI party country code, e.g. NL (case-insensitive).

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

Only rows of this OCPI party id, e.g. OCP (case-insensitive).

roleenum or nullOptional
Only rows with this OCPI role, e.g. CPO or EMSP.
originenum or nullOptional

LOCAL rows are yours; REMOTE rows came from a roaming partner.

Allowed values:
reservation_statusenum or nullOptional
Only reservations in this lifecycle status.

Response

One page of reservations, lowest id first; pagination.has_next says whether another page follows.

datalist of objects
paginationobject

Cursor page. Pass end_cursor as the next after value.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error