Skip to content
As Markdown
API reference

Zugänge

9 endpoints

The endpoint descriptions come directly from the API and are in German.

Zugänge auflisten

get/v1/access_grants

Personen und Ladekarten, die gratis oder zum Sondertarif laden.

Response 200AccessGrantList

NameTypeDescription
objectrequired"list"
datarequiredAccessGrant[]
has_morerequiredboolean

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X GET https://api.ladehase.com/v1/access_grants \n  -H "Authorization: Bearer lh_test_…"
Response 200
{
  "object": "list",
  "data": [
    {
      "id": "acc_0e9d8c7b6a5f4e3d",
      "object": "access_grant",
      "name": "string",
      "email": "string",
      "rfid_uid": "string",
      "link_url": "string",
      "free": true,
      "tariff_id": "string",
      "monthly_limit_wh": 0,
      "revoked": true,
      "created_at": "string"
    }
  ],
  "has_more": true
}

Zugang anlegen

post/v1/access_grants

Ohne `tariff_id` gratis, mit `tariff_id` Sondertarif und Monatsabrechnung. Erzeugt einen persönlichen Link.

Parameters

NameInType
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Headerstring

Request

NameTypeDescription
namerequiredstring
emailoptionalstring | null
rfid_uidoptionalstring | null
create_linkoptionalboolean
valid_fromoptionalstring | null
valid_untiloptionalstring | null
device_idsoptionalstring[]
tariff_idoptionalstring | null
monthly_limit_whoptionalinteger | null
billing_integration_idoptionalstring | null
noteoptionalstring | null

Response 201AccessGrant

NameTypeDescription
idrequiredstringID mit Präfix «acc_»
objectrequired"access_grant"
namerequiredstring
emailrequiredstring | null
rfid_uidrequiredstring | null
link_urlrequiredstring | nullPersönlicher Link zum Laden ohne Zahlung
freerequiredboolean
tariff_idrequiredstring | null
monthly_limit_whrequiredinteger | null
revokedrequiredboolean
created_atrequiredstring

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X POST https://api.ladehase.com/v1/access_grants \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","email":"person@example.ch","rfid_uid":"string","create_link":true,"valid_from":"2026-10-25T08:30:00.000Z","valid_until":"2026-10-25T08:30:00.000Z","device_ids":[],"tariff_id":"string","monthly_limit_wh":0,"billing_integration_id":"string","note":"string"}'
Response 201
{
  "id": "acc_0e9d8c7b6a5f4e3d",
  "object": "access_grant",
  "name": "string",
  "email": "string",
  "rfid_uid": "string",
  "link_url": "string",
  "free": true,
  "tariff_id": "string",
  "monthly_limit_wh": 0,
  "revoked": true,
  "created_at": "string"
}

Zugang abrufen

get/v1/access_grants/{id}

Ein Zugang.

Parameters

NameInType
idrequiredPathstring

Response 200AccessGrant

NameTypeDescription
idrequiredstringID mit Präfix «acc_»
objectrequired"access_grant"
namerequiredstring
emailrequiredstring | null
rfid_uidrequiredstring | null
link_urlrequiredstring | nullPersönlicher Link zum Laden ohne Zahlung
freerequiredboolean
tariff_idrequiredstring | null
monthly_limit_whrequiredinteger | null
revokedrequiredboolean
created_atrequiredstring

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X GET https://api.ladehase.com/v1/access_grants/{id} \n  -H "Authorization: Bearer lh_test_…"
Response 200
{
  "id": "acc_0e9d8c7b6a5f4e3d",
  "object": "access_grant",
  "name": "string",
  "email": "string",
  "rfid_uid": "string",
  "link_url": "string",
  "free": true,
  "tariff_id": "string",
  "monthly_limit_wh": 0,
  "revoked": true,
  "created_at": "string"
}

Zugang ändern

patch/v1/access_grants/{id}

Auch `revoked` und `regenerate_link`.

Parameters

NameInType
idrequiredPathstring

Request

NameTypeDescription
nameoptionalstring
emailoptionalstring | null
rfid_uidoptionalstring | null
create_linkoptionalboolean
valid_fromoptionalstring | null
valid_untiloptionalstring | null
device_idsoptionalstring[]
tariff_idoptionalstring | null
monthly_limit_whoptionalinteger | null
billing_integration_idoptionalstring | null
noteoptionalstring | null
revokedoptionalboolean
regenerate_linkoptionalboolean

Response 200AccessGrant

NameTypeDescription
idrequiredstringID mit Präfix «acc_»
objectrequired"access_grant"
namerequiredstring
emailrequiredstring | null
rfid_uidrequiredstring | null
link_urlrequiredstring | nullPersönlicher Link zum Laden ohne Zahlung
freerequiredboolean
tariff_idrequiredstring | null
monthly_limit_whrequiredinteger | null
revokedrequiredboolean
created_atrequiredstring

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X PATCH https://api.ladehase.com/v1/access_grants/{id} \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","email":"person@example.ch","rfid_uid":"string","create_link":true,"valid_from":"2026-10-25T08:30:00.000Z","valid_until":"2026-10-25T08:30:00.000Z","device_ids":[],"tariff_id":"string","monthly_limit_wh":0,"billing_integration_id":"string","note":"string","revoked":true,"regenerate_link":true}'
Response 200
{
  "id": "acc_0e9d8c7b6a5f4e3d",
  "object": "access_grant",
  "name": "string",
  "email": "string",
  "rfid_uid": "string",
  "link_url": "string",
  "free": true,
  "tariff_id": "string",
  "monthly_limit_wh": 0,
  "revoked": true,
  "created_at": "string"
}

Zugang widerrufen

delete/v1/access_grants/{id}

Link und Berechtigung werden ungültig.

Parameters

NameInType
idrequiredPathstring

Response 200Deleted

NameTypeDescription
idrequiredstring
objectrequiredstring
deletedrequiredtrue

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X DELETE https://api.ladehase.com/v1/access_grants/{id} \n  -H "Authorization: Bearer lh_test_…"
Response 200
{
  "id": "string",
  "object": "string",
  "deleted": true
}

Monatsabrechnungen

get/v1/billing_statements

Abrechnungen für Zugänge mit Sondertarif.

Parameters

NameInType
periodoptionalQuerystring

Response 200Object

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X GET https://api.ladehase.com/v1/billing_statements \n  -H "Authorization: Bearer lh_test_…"
Response 200
{}

Abrechnungen erstellen

post/v1/billing_statements/generate

Für einen Monat (`period` = JJJJ-MM).

Parameters

NameInType
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Headerstring

Request

NameTypeDescription
periodrequiredstring

Response 200Object

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X POST https://api.ladehase.com/v1/billing_statements/generate \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"period":"string"}'
Response 200
{}

Abrechnung senden

post/v1/billing_statements/{id}/send

E-Mail mit Zahlungslink über zahls.ch oder Freika.

Parameters

NameInType
idrequiredPathstring
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Headerstring

Response 200Object

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X POST https://api.ladehase.com/v1/billing_statements/{id}/send \n  -H "Authorization: Bearer lh_test_…"
Response 200
{}

Als bezahlt markieren

post/v1/billing_statements/{id}/paid

Zum Beispiel bei Barzahlung.

Parameters

NameInType
idrequiredPathstring
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Headerstring

Response 200Object

Possible errors

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Example
curl -X POST https://api.ladehase.com/v1/billing_statements/{id}/paid \n  -H "Authorization: Bearer lh_test_…"
Response 200
{}