Skip to navigation

List locations

Your locations and those received from roaming partners, most recently changed first.

Authentication

AuthorizationBearer

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

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.
originenum or nullOptional

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

Allowed values:
publishboolean or nullOptional

Only published (true) or unpublished (false) locations.

offsetintegerOptional>=0Defaults to 0

Rows to skip. Pass the previous page’s next_offset to continue.

limitintegerOptional1-200Defaults to 50

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

Response

One page of results; next_offset is null on the last page.

itemslist of objects
offsetinteger
limitinteger
next_offsetinteger or nullOptional

Errors

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