Jump to Content
Home
Guides
API Reference
Changelog
v3.121.0
v3.123.0
v3.124.0
v3.125.0
v3.126.0
v3.127.0
v3.128.0
v3.129.0
v3.130.0
v3.131.0
v3.132.0
v3.133.0
v3.134.0
v3.135.0
v3.136.0
v3.137.0
v3.138.0
v3.139.0
v3.140.0
v3.141.0
v3.142.0
v3.143.0
v3.144.0
v3.145.0
v3.146.0
Terms of Use
API Reference
Terms of Use
v3.146.0
Home
Guides
API Reference
Changelog
resource / partner contracts
All
Pages
Start typing to search…
JUMP TO
GET STARTED
Authorization
Pagination
Notifications
Data formats
EVSE statuses
Backward compatibility
API rate limits
Public API
action / certificate
Certificate / Reissue an EMAID
post
Certificate / Issue an EMAID
post
action / charge point
Charge Point / Change Availability
post
Charge Point / Change Owner
post
Charge Point / Clear Charging Profile
post
Charge Point / Disconnect
post
Charge Point / Get Diagnostics
post
Charge Point / Get Security Log
post
Charge Point / Move EVSEs to Satellite
post
Charge Point / Reserve
post
Charge Point / Reset Security Profile
post
Charge Point / Reset
post
Charge Point / Send Data Transfer
post
Charge Point / Set Charging Profile
post
Charge Point / Start Charging Session Without EVSE
post
Charge Point / Start Charging Session
post
Charge Point / Stop Charging Session
post
Charge Point / Sync Configuration
post
Charge Point / Trigger Message Charge Point
post
Charge Point / EVSE / Unlock
post
Charge Point / Change sharing code
post
Charge Point / Delete Certificate
post
Charge Point / Install Certificate
post
Charge Point / Set Configuration
post
Charge Point / Set Security Profile
post
Charge Point / Get Installed Certificate IDs
post
Charge Point / Update Firmware
post
action / circuit
Circuit / Attach Charge Point
post
Circuit / Detach Charge Point
post
Circuit / Set Charge Point Priority
post
Circuit / Set Charge Point EVSE Priority
post
Circuit / Set Circuit SoC Priority
post
Circuit / Set Session Priority
post
action / configuration template
Configuration Template / Apply to Charge Points
post
Configuration Template / Bulk Create Variables
post
action / electricity meter
Electricity Meter / Report Consumption
post
action / evse
EVSEs / Bulk Assign Tariff Groups
post
EVSE / Start Charging with EVSE ID
post
EVSE / Trigger Message
post
action / flexibility asset
Flexibility Asset / Change Status
post
Flexibility Asset / Create Activation Request
post
action / installer job
Actions / Assign Charge Points
post
Actions / Change Status
post
action / invoice
Invoice / Update External ID
post
action / location
Location / Check Booking Availability
post
action / notifications
Notifications / Resend Failed
post
action / parking space
Parking Space / Update occupancy status
post
action / partner settlement report
Partner Settlement Report / Update External ID
post
action / reservation
Reservation / Cancel
post
action / roaming operator
Custom Tariff Filters / Set Pricing Data
post
action / session
Session / Assign to user
post
Session / Retry Payment
post
Session / Change tariff
post
action / subscription-plan
Subscription plan / Replace
post
action / tariff
Tariff / Set Display Information
post
action / transaction
Transaction / Issue Invoice
post
Transaction / Resend Invoice
post
Transaction / Update Payment Reference
post
action / user
User / Activate subscription
post
User / Add Balance
post
User / Apply Custom Fee
post
User / Cancel subscription
post
User / Change Status
post
User / Clear subscription amount due
post
User / Export All Private Data
get
User / Redeem Voucher
post
notifications
Notifications / Subscribe
post
Notifications / Listing
get
Notifications / Read
get
Notifications / Update
put
Notifications / Unsubscribe
del
Notifications / Subscribe
post
Notifications / Listing
get
Notification / Read
get
Notifications / Update
put
Notifications / Unsubscribe
del
resource / admins
Admins / Listing
get
Admin / Read
get
Admin / Permissions
get
resource / authorizations
Authorization / Read
get
Authorizations / Listing
get
Authorization / Read
get
Authorizations / Listing
get
Authorization / Read
get
resource / booking requests
Booking Requests / Listing
get
Booking Request / Create
post
Booking Request / Read
get
resource / bookings
Bookings / Listing
get
Booking / Read
get
resource / cdrs
CDRs / Listing
get
CDR / Read
get
resource / charge point downtime periods
Charge Point Downtime Periods / Listing
get
Charge Point Downtime Period / Create
post
Charge Point Downtime Period / Read
get
Charge Point Downtime Period / Update
patch
Charge Point Downtime Period / Delete
del
Charge Point Downtime Period / Status Log
get
resource / charge point models
Charge Point Models / Listing
get
Charge Point Model / Create
post
Charge Point Model / Read
get
Charge Point Model / Update
patch
Charge Point Model / Delete
del
Charge Point Models / Listing
get
Charge Point Model / Create
post
Charge Point Model / Read
get
Charge Point Model / Update
patch
Charge Point Model / Delete
del
resource / charge point vendors
Charge Point Vendors / Listing
get
Charge Point Vendor / Create
post
Charge Point Vendor / Read
get
Charge Point Vendor / Update
patch
Charge Point Vendor / Delete
del
Charge Point Vendors / Listing
get
Charge Point Vendor / Create
post
Charge Point Vendor / Read
get
Charge Point Vendor / Update
patch
Charge Point Vendor / Delete
del
resource / charge points
Charge Points / Listing
get
Charge Point / Create
post
Charge Point / Read
get
Charge Point / Update
patch
Charge Point / Delete
del
Charge Point / Configurations / Listing
get
Charge Point / Configuration / Read
get
Charge Point / Configuration / Update
patch
Charge Point / Status / Read
get
Charge Point / Create
post
Charge Points / Listing
get
Charge Point / Update
patch
Charge Point / Read
get
Charge Point / Delete
del
Charge Point / Available personal smart charging modes / Listing
get
Charge Point / Configurations / Listing
get
Charge Point / Configuration / Read
get
Charge Point / Configuration / Update
patch
Charge Point / EVSE / Create
post
Charge Point / EVSEs / Listing
get
Charge Point / EVSE / Update
patch
Charge Point / EVSE / Read
get
Charge Point / EVSE / Delete
del
Charge Point / Evse / Connectors / Listing
get
Charge Points / Evse / Connector / Create
post
Charge Points / Evse / Connector / Read
get
Charge Points / Evse / Connector / Update
patch
Charge Points / Evse / Connector / Delete
del
Charge Point / Hardware Status Logs / Listing
get
Charge Point / Latest Hardware Status Log
get
Charge Point / Latest Network Status Log
get
Charge Point / Network Status Logs / Listing
get
Charge Point / Notes / Listing
get
Charge Point / Note / Create
post
Charge Point / Note / Read
get
Charge Point / Note / Update
patch
Charge Point / Note / Delete
del
Charge Point / Personal smart charging preferences / Read
get
Charge Point / Personal smart charging preferences / Update
post
Charge Point / Shared Partners / Listing
get
Charge Point / Shared Partners / Update
put
Charge Point / Share / Create
post
Charge Point / Shares / Listing
get
Charge Point / Share / Read
get
Charge Point / Share / Delete
del
Charge Point / Smart Charging / Update
post
resource / circuits
Circuits / Listing
get
Circuit / Create
post
Circuit / Read
get
Circuit / Update
patch
Circuit / Delete
del
Circuit / Consumption (all phases)
get
Circuit / Consumption (phase)
get
Circuits / Listing
get
Circuit / Create
post
Circuit / Read
get
Circuit / Update
patch
Circuit / Delete
del
Circuit / Charge Point Priorities / Listing
get
Circuit / Consumption
get
Circuit / SoC Priorities / Listing
get
Circuit / Unmanaged Load / Read
get
Circuits / User Priorities / Listing
get
Circuits / User Priority / Create
post
Circuits / User Priority / Read
get
Circuits / User Priority / Update
patch
Circuits / User Priority / Delete
del
resource / configuration templates
Configuration Template / Listing
get
Configuration Template / Create
post
Configuration Template / Update
patch
Configuration Template / Read
get
Configuration Template / Delete
del
Configuration Template Variable / Listing
get
Configuration Template Variable / Create
post
Configuration Template Variable / Update
patch
Configuration Template Variable / Delete
del
resource / consent-history
Consent History / Listing
get
resource / consents
Consents / Listing
get
Consents / Create
post
resource / contact details
Contact details / Read
get
Contact details / Update
put
Contact details / Delete
del
resource / currencies
Currencies / Listing
get
Currency / Create
post
Currency / Read
get
Currency / Update
patch
Currency / Delete
del
resource / currency rates
Currency Rate / Create
post
Currency Rate / Listing
get
Currency Rate / Update
patch
Currency Rate / Read
get
Currency Rate / Delete
del
resource / custom fees
Custom Fees / Listing
get
Custom Fee / Read
get
resource / downtime period notices
Downtime Period Notices / Listing
get
Downtime Period Notices / Create
post
Downtime Period Notices / Read
get
Downtime Period Notices / Update
patch
Downtime Period Notices / Delete
del
resource / electricity meters
Electricity Meters / Listing
get
Electricity Meter / Create
post
Electricity Meter / Read
get
Electricity Meter / Update
patch
Electricity Meter / Delete
del
resource / electricity rates
Electricity rates / Listing
get
Electricity rate / Create
post
Electricity rate / Read
get
Electricity rate / Update
put
Electricity rate / Delete
del
Electricity rates / Listing
get
Electricity rate / Create
post
Electricity rate / Read
get
Electricity rate / Update
patch
Electricity rate / Delete
del
Electricity rate / Energy Mix / Read
get
Electricity rate / Energy Mix / Update
put
Electricity rate / Price periods / Listing
get
Electricity rate / Price periods / Date / Listing
get
Electricity rate / Price periods / Date / Read
get
Electricity rate / Price periods / Date / Create or update
put
Electricity rate / Price periods / Date / Delete
del
Electricity rate / Price periods / Week day / Listing
get
Electricity rate / Price periods / Week day / Read
get
Electricity rate / Price periods / Week day / Create or update
put
Electricity rate / Price periods / Week day / Delete
del
resource / evse downtime periods
EVSE Downtime Periods / Listing
get
EVSE Downtime Period / Create
post
EVSE Downtime Period / Read
get
EVSE Downtime Period / Update
patch
EVSE Downtime Period / Delete
del
EVSE Downtime Period / Status Log
get
resource / evses
EVSEs / Listing
get
EVSE / Read
get
EVSE / Update
put
EVSE / Hardware Status Logs / Listing
get
EVSE / Latest Hardware Status Log
get
EVSE / Notes / Listing
get
EVSE / Note / Create
post
EVSE / Note / Read
get
EVSE / Note / Update
patch
EVSE / Note / Delete
del
EVSE / Create
post
EVSEs / Listing
get
EVSE / Update
patch
EVSE / Read
get
EVSE / Delete
del
resource / faqs
resource / firmware versions
Firmware Versions / Listing
get
Firmware Version / Read
get
Firmware Version / Attached Models
get
resource / flexibility activation requests
Flexibility Activation Requests / Listing
get
Flexibility Activation Requests / Read
get
resource / flexibility assets
Flexibility Assets / Create
post
Flexibility Assets / Listing
get
Flexibility Assets / Update
patch
Flexibility Assets / Read
get
Flexibility Assets / Delete
del
Flexibility Assets / Historical Time Series
get
Flexibility Assets / Time Series Forecast
get
resource / id tags
Id Tags / Listing
get
Id Tag / Create
post
Id Tag / Read
get
Id Tag / Update
patch
Id Tag / Delete
del
resource / installation and maintenance companies
Installation And Maintenance Companies / Listing
get
Installation And Maintenance Companies / Create
post
Installation And Maintenance Companies / Read
get
Installation And Maintenance Companies / Update
patch
Installation And Maintenance Companies / Delete
del
resource / installer jobs
InstallerJobs / Listing
get
Installer Jobs / Create
post
Installer Jobs / Read
get
Installer Jobs / Update
patch
Installer Jobs / Delete
del
resource / invoices
Invoices / Listing
get
Invoice / Read
get
resource / issues
Issues / Listing
get
Issues / Create
post
Issue / Read
get
Issue / Update
patch
Issue / Delete
del
resource / locations
Locations / Listing
get
Location / Create
post
Location / Read
get
Location / Update
patch
Location / Delete
del
Location / Create
post
Locations / Listing
get
Location / Update
patch
Location / Read
get
Location / Delete
del
Location / Charging Zones / Listing
get
Location / Charging Zone / Create
post
Location / Charging Zone / Read
get
Location / Charging Zones / Update
patch
Location / Charging Zone / Delete
del
Location / Notes / Listing
get
Location / Note / Create
post
Location / Note / Read
get
Location / Note / Update
patch
Location / Note / Delete
del
resource / parking spaces
Parking Space / Create
post
Parking Space / Listing
get
Parking Space / Update
put
Parking Space / Update
patch
Parking Space / Read
get
Parking Space / Delete
del
Parking Space / EVSEs / Listing
get
Parking Space / EVSEs / Update
put
resource / partner contracts
resource / partner invites
Partner Invites / Listing
get
Partner Invite / Create
post
Partner Invite / Read
get
Partner Invite / Update
patch
Partner Invite / Delete
del
resource / partner settlement reports
Partner Settlement Reports / Listing
get
Partner Settlement Report / Read
get
Partner Settlement Report / Partner Settlement Records / Listing
get
Partner Settlement Report / Partner Settlement Record / Create
post
Partner Settlement Report / Partner Settlement Record / Read
get
Partner Settlement Report / Partner Settlement Record / Update
put
Partner Settlement Report / Partner Settlement Record / Delete
del
resource / partners
Partners / Listing
get
Partner / Create
post
Partner / Read
get
Partner / Update
patch
Partner / Delete
del
Partners / Listing
get
Partner / Create
post
Partner / Read
get
Partner / Update
patch
Partner / Delete
del
Partner / Admins / Listing
get
Partner / Admin / Create
post
Partner / Admin / Update
patch
Partner / Admin / Delete
del
Partner / Notes / Listing
get
Partner / Note / Create
post
Partner / Note / Read
get
Partner / Note / Update
patch
Partner / Note / Delete
del
resource / payment terminals
Payment Terminals / Listing
get
Payment Terminals / Create
post
Payment Terminals / Read
get
Payment Terminals / Update
patch
Payment Terminals / Delete
del
Payment Terminals / Listing
get
Payment Terminals / Create
post
Payment Terminals / Read
get
Payment Terminals / Update
patch
Payment Terminals / Delete
del
resource / provisioning certificate
Provisioning Certificate / Create
post
Provisioning Certificate / Listing
get
Provisioning Certificate / Update
patch
Provisioning Certificate / Read
get
Provisioning Certificates / Delete
del
resource / receipts
Receipts / Listing
get
Receipt / Read
get
resource / reservations
Reservations / Listing
get
Reservation / Read
get
resource / revenues & expenses
Expenses / Listing
get
Expenses / Listing
get
Revenues / Listing
get
Revenues / Listing
get
resource / rfids
RFID Tags / Listing
get
RFID Tag / Create
post
RFID Tag / Read
get
RFID Tag / Update
patch
RFID Tag / Delete
del
resource / roaming connections
Roaming Connections / Listing
get
Roaming Connections / Read
get
resource / roaming operators
Roaming Operators / Listing
get
Roaming Operator / Read
get
Roaming Operator / Update
patch
Roaming Operators / Custom Tariff Filters / Listing
get
Roaming Operators / Custom Tariff Filters / Create
post
Roaming Operators / Custom Tariff Filters / Reorder
put
Roaming Operators / Custom Tariff Filters / Read
get
Roaming Operators / Custom Tariff Filters / Update
patch
Roaming Operators / Custom Tariff Filters / Delete
del
resource / roaming platforms
Roaming Platforms / Listing
get
Roaming Platform / Read
get
resource / roaming providers
Roaming Providers / Listing
get
Roaming Provider / Create
post
Roaming Provider / Read
get
Roaming Provider / Update
patch
Roaming Provider / Delete
del
resource / roaming tariffs
Roaming Tariffs / Listing
get
Roaming Tariff / Read
get
Roaming Tariff / Update
patch
resource / security event logs
Security Events Logs / Listing
get
Security Event Log / Read
get
resource / security events
Security Events / Listing
get
Security Event / Read
get
resource / sessions
Sessions / Listing
get
Session / Read
get
Sessions / Consumption Stats / Read
get
resource / settings
Settings / Listing
get
resource / sub operators
Sub operators / Listing
get
Sub operator / Read
get
Sub Operator / Notes / Listing
get
Sub Operator / Note / Create
post
Sub Operator / Note / Read
get
Sub Operator / Note / Update
patch
Sub Operator / Note / Delete
del
resource / subscription-plans
Subscription Plans / Listing
get
Subscription plans / Listing
get
Subscription plan / Create
post
Subscription plan / Read
get
Subscription plan / Update
patch
Subscription plan / Delete
del
resource / subscriptions
Subscriptions / Listing
get
Subscription / Read
get
resource / tariffs
Tariff Groups / Listing
get
Tariff Group / Create
post
Tariff Group / Read
get
Tariff Group / Update
put
Tariff Group / Delete
del
Tariff Snapshot / Read
get
Tariffs / Listing
get
Tariff / Create
post
Tariff / Read
get
Tariff / Update
put
Tariff / Delete
del
resource / tax identification numbers
Tax Identification Numbers / Listing
get
Tax Identification Number / Create
post
Tax Identification Number / Read
get
Tax Identification Number / Update
patch
Tax Identification Number / Delete
del
resource / taxes
Taxes / Listing
get
Tax / Create
post
Tax / Read
get
Tax / Update
patch
Tax / Delete
del
resource / templates
Templates / Listing
get
resource / terms and policies
Terms and policies / Listing
get
Terms and policies / Read
get
resource / top-up packages
Top-Up Packages / Listing
get
Top-Up Package / Create
post
Top-Up Package / Read
get
Top-Up Package / Update
patch
Top-Up Package / Delete
del
resource / transactions
Transactions / Listing
get
Transactions / Create
post
Transaction / Read
get
Transaction / Update
patch
resource / user-groups
User Groups / Listing
get
User Group / Create
post
User Group / Read
get
User Group / Update
patch
User Group / Delete
del
resource / users
Users / Listing
get
User / Create
post
User / Read
get
User / Update
patch
User / Delete
del
Invoice details / Read
get
Invoice details / Create or update
post
Payment Methods / Listing
get
Payment Method / Create
post
Payment Method / Read
get
Payment Method / Update
patch
Payment Method / Delete
del
Users / Listing
get
User / Create
post
User / Read
get
User / Update
patch
User / Delete
del
resource / utilities
Utilities / Listing
get
Utilities / Create
post
Utilities / Read
get
Utilities / Update
put
Utilities / Delete
del
resource / vendor error codes
Vendor Error Codes / Listing
get
Vendor Error Code / Create
post
Vendor Error Code / Read
get
Vendor Error Code / Update
patch
Vendor Error Code / Delete
del
resource / vouchers
Vouchers / Listing
get
Voucher / Create
post
Voucher / Read
get
Voucher / Update
patch
Voucher / Delete
del
Vouchers / Listing
get
Voucher / Create
post
Voucher / Read
get
Voucher / Update
patch
Voucher / Delete
del
logs / communication
Communication logs / Listing
get
Communication log / Read
get
resource / faqs
FAQs / Listing
get
FAQ / Create
post
FAQ / Read
get
FAQ / Update
patch
FAQ / Delete
del
resource / partner contracts
Partner Contracts / Listing
get
Partner Contract / Create
post
Partner Contract / Read
get
Partner Contract / Update
put
Partner Contract / Delete
del
Partner Contract / Patch
patch
logs / ocpi
OCPI Logs / Listing
get
OCPI Log / Read
get
resource / operators
Operators / Listing
get
Operator / Read
get
action / tax
Taxes / Validate VAT number
post
Powered by
resource / partner contracts
Ask AI
