Smithery is now a part of Arcade.dev! Read more in our announcement here
Explore AMPECO Public API endpoints, schemas, and develop integrations with the EV charging platform...
Explore and integrate with the AMPECO EV Charging Platform Public API.
Before using the reference documentation, ensure you have the latest API spec:
bash scripts/fetch-and-generate.sh
This fetches the latest OpenAPI spec from https://developers.ampeco.com/openapi/ and regenerates all reference files.
Prerequisites: curl and jq must be installed:
brew install jqapt-get install jqContact your AMPECO Customer Success Manager or generate a token in: Back Office → API Access Tokens
https://{tenantUrl}/public-api/
Replace {tenantUrl} with your organization's tenant URL.
Two schemes are supported; both send the same header at the wire level.
Long-lived admin token — use the UUID token directly:
curl -H "Authorization: Bearer {your-api-token}" \
https://{tenantUrl}/public-api/resources/charge-points/v2.0/
OAuth 2.0 client credentials — exchange first, then use the access token:
curl -X POST https://{tenantUrl}/public-api/oauth/token \
-H 'Content-Type: application/json' \
-d '{"grant_type":"client_credentials","client_id":"...","client_secret":"..."}'
The client_secret is not a valid bearer token on its own — it must be exchanged at
/public-api/oauth/token (RFC 6749 §4.4). Revoke tokens at /public-api/oauth/revoke.
Response Format: JSON with data wrapper
{
"data": [...],
"links": { "first": "...", "last": null, "prev": null, "next": "...?cursor=eyJ..." },
"meta": { "path": "...", "per_page": 100, "next_cursor": "eyJ...", "prev_cursor": null }
}
Path Patterns:
/public-api/resources/{resource-name}/v{X.Y}//public-api/actions/{target}/v{X.Y}/{id}/{action} — the target segment is not
derivable from the resource segment. Most are singular (actions/charge-point/... for
resources/charge-points/...); five are plural-only (locations, notifications,
parking-spaces, subscription-plans, tariffs); and user/users and
transaction/transactions both exist, carrying different actions. Always copy the
exact path from reference/endpoints-index.md./public-api/notifications/v{X.Y}//public-api/logs/{communication|ocpi}/v{X.Y}//public-api/oauth/{token|revoke} (unversioned)| Resource | Version | Operations |
|---|---|---|
| Admins | v1.0 | Read |
| Authorizations | v1.0, 2.0, 2.1 | Read |
| Booking Requests | v1.0 | Create, Read |
| Bookings | v1.0 | Read |
| Cdrs | v2.0 | Read |
| Charge Point Downtime Periods | v1.0 | Create, Delete, Read, Update |
| Charge Point Models | v1.0 | Create, Delete, Read, Update |
| Charge Point Vendors | v1.0 | Create, Delete, Read, Update |
| Charge Points | v1.0, 2.0 | Create, Delete, Read, Update |
| Circuits | v1.0, 2.0 | Create, Delete, Read, Update |
| Configuration Templates | v1.0 | Create, Delete, Read, Update |
| Consent History | v1.0 | Read |
| Consents | v1.0 | Create, Read |
| Contact Details | v2.0 | Delete, Read, Update |
| Cp Models | v1.0 | Create, Delete, Read, Update |
| Cp Vendors | v1.0 | Create, Delete, Read, Update |
| Currencies | v2.0 | Create, Delete, Read, Update |
| Currency Rates | v1.0 | Create, Delete, Read, Update |
| Custom Fees | v2.0 | Read |
| Downtime Period Notices | v1.0 | Create, Delete, Read, Update |
| Electricity Meters | v1.0 | Create, Delete, Read, Update |
| Electricity Rates | v1.0, 2.0 | Create, Delete, Read, Update |
| Energy Coupon Templates | v1.0 | Create, Read, Update |
| Energy Coupons | v1.0 | Create, Read |
| Evse Downtime Periods | v1.0 | Create, Delete, Read, Update |
| Evses | v2.0, 2.1 | Create, Delete, Read, Update |
| Faqs | v2.0 | Create, Delete, Read, Update |
| Firmware Versions | v1.0 | Read |
| Flexibility Activation Requests | v1.0 | Read |
| Flexibility Assets | v1.0 | Create, Delete, Read, Update |
| Id Tags | v2.0 | Create, Delete, Read, Update |
| Installation And Maintenance Companies | v1.0 | Create, Delete, Read, Update |
| Installer Jobs | v1.0 | Create, Delete, Read, Update |
| Invoices | v1.0 | Read |
| Issues | v1.0 | Create, Delete, Read, Update |
| Locations | v1.0, 2.0 | Create, Delete, Read, Update |
| Ocpi Commands | v1.0 | Read |
| Operators | v1.0 | Read |
| Parking Spaces | v1.0 | Create, Delete, Read, Update |
| Partner Contracts | v1.0 | Create, Delete, Read, Update |
| Partner Expenses | v1.0, 1.1, 1.2 | Read |
| Partner Invite Access Policies | v1.0 | Create, Delete, Read, Update |
| Partner Invite Corporate Billing Policies | v1.0 | Create, Delete, Read, Update |
| Partner Invite Corporate Billing Policy Snapshots | v1.0 | Read |
| Partner Invites | v1.0, 2.0 | Create, Delete, Read, Update |
| Partner Invoices | v1.0 | Read |
| Partner Revenues | v1.0, 1.1, 1.2 | Read |
| Partner Settlement Reports | v1.0 | Create, Delete, Read, Update |
| Partners | v1.0, 2.0 | Create, Delete, Read, Update |
| Payment Terminals | v1.0, 1.1 | Create, Delete, Read, Update |
| Provisioning Certificates | v2.0 | Create, Delete, Read, Update |
| Receipts | v2.0 | Read |
| Reimbursement Policies | v1.0 | Create, Delete, Read, Update |
| Reimbursement Records | v1.0 | Read |
| Reimbursement Reports | v1.0 | Read |
| Reservations | v1.0 | Read |
| Rfid Tags | v1.0 | Create, Delete, Read, Update |
| Roaming Connections | v2.0 | Read |
| Roaming Cpos | v1.0 | Read, Update |
| Roaming Emsps | v1.0 | Create, Delete, Read, Update |
| Roaming Operators | v2.0 | Create, Delete, Read, Update |
| Roaming Platforms | v1.0 | Read |
| Roaming Providers | v2.0 | Create, Delete, Read, Update |
| Roaming Tariffs | v2.0 | Read, Update |
| Security Events | v2.0 | Read |
| Security Events Log | v2.0 | Read |
| Sessions | v1.0 | Read |
| Settings | v1.0 | Read |
| Sharing Invites | v1.0 | Read |
| Sub Operators | v1.0, 2.0 | Create, Delete, Read, Update |
| Subscription Plans | v1.0, 2.0 | Create, Delete, Read, Update |
| Subscriptions | v1.0 | Read |
| Tariff Groups | v1.0 | Create, Delete, Read, Update |
| Tariff Snapshots | v1.0 | Read |
| Tariffs | v1.0 | Create, Delete, Read, Update |
| Tax Identification Numbers | v2.0 | Create, Delete, Read, Update |
| Taxes | v2.0 | Create, Delete, Read, Update |
| Templates | v1.0 | Read |
| Terms And Policies | v2.0 | Read |
| Top Up Packages | v2.0 | Create, Delete, Read, Update |
| Transactions | v1.0 | Create, Read, Update |
| User Devices | v1.0 | Read |
| User Groups | v1.0 | Create, Delete, Read, Update |
| Users | v1.0, 1.1 | Create, Delete, Read, Update |
| Utilities | v1.0 | Create, Delete, Read, Update |
| Vehicles | v1.0 | Create, Delete, Read, Update |
| Vendor Error Codes | v2.0 | Create, Delete, Read, Update |
| Vouchers | v2.0, 2.1 | Create, Delete, Read, Update |
Run bash scripts/fetch-and-generate.sh to update this index
Actions: See reference/endpoints-index.md for charge point, user, reservation, and notification actions.
Understanding how AMPECO entities relate helps you choose the right endpoints.
Operator (tenant scope)
├── Location → ChargePoint → EVSE → Session
├── User → Session, PartnerInvite
├── Partner → ChargePoint (owned), PartnerInvite (users)
└── Tariff, SubscriptionPlan
Common Use Cases:
| Task | Key Endpoints |
|---|---|
| Charge point stats | sessions?filter[chargePointId]=, sessions/{id}/consumption-stats |
| User billing | sessions?filter[userId]=, transactions?filter[userId]=, receipts |
| Fleet management | charge-points?filter[partnerId]=, partner-invites, partner-revenues |
| Start/stop charging | actions/charge-point/{id}/start/{evse}, actions/charge-point/{id}/stop/{session} |
See reference/data-model.md for detailed relationships and recipes.
Cursor pagination (the only supported form on new work):
GET /public-api/resources/users/v1.0?cursor&per_page=25
GET /public-api/resources/users/v1.0?cursor={cursor_from_links.next}&per_page=25
Pass an empty ?cursor to start, then take the value from links.next (also exposed as
meta.next_cursor) — never build one by hand. per_page defaults to 100 and caps at 100 on
resource endpoints; the /public-api/logs/* endpoints default to 500 and cap at 500.
page is deprecated with a sunset date of Mon, 01 Jun 2026. Do not write new integrations
against ?page=N.
Use filter[fieldName]=value format:
GET /public-api/resources/sessions/v1.0?filter[userId]=123
GET /public-api/resources/sessions/v1.0?filter[status]=active
GET /public-api/resources/sessions/v1.0?filter[startedAfter]=2024-01-01T00:00:00Z
Embed related resources with include[]=relationName:
GET /public-api/resources/charge-points/v2.0?include[]=lastBootNotification&include[]=chargingProfile
Valid values differ per resource — check the endpoint's include parameter in
reference/endpoints-index.md rather than reusing another resource's.
{
"message": "Unauthenticated."
}
Status codes: 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 409 (Conflict),
422 (Validation Error), 429 (Rate Limited — see the X-RateLimit-* response headers).
Deprecated endpoints return Deprecation and Sunset response headers.
OAuth endpoints use the RFC 6749 shape instead: {"error": "...", "error_description": "..."}.
bash scripts/fetch-and-generate.sh to get latest docsreference/endpoints-index.mdreference/schemas-index.mdreference/common-patterns.md for pagination, filtering, errorsreference/deprecation-map.mdreference/data-model.md - Entity relationships and use case recipesreference/endpoints-index.md - Complete list of all endpointsreference/schemas-index.md - Schema summariesreference/deprecation-map.md - Deprecated endpointsreference/common-patterns.md - Pagination, filtering, errors