Skip to content
As Markdown
API reference

Organisation

2 endpoints

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

Organisation abrufen

get/v1/organization

Einstellungen der Organisation dieses API-Schlüssels: Name, Subdomain der Instanz, MWST, Branding, Testmodus.

Response 200Organization

NameTypeDescription
idrequiredstringID mit Präfix «org_»
objectrequired"organization"
namerequiredstring
slugrequiredstringSubdomain der Instanz
instance_urlrequiredstring
test_moderequiredbooleanTestmodus mit simulierten Ladepunkten und Testzahlungen
vat_registeredrequiredboolean
vat_numberrequiredstring | null
vat_rate_bpsrequiredintegerMWST-Satz in Basispunkten (810 = 8.1 %)
accent_colorrequiredstring | null

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/organization \n  -H "Authorization: Bearer lh_test_…"
Response 200
{
  "id": "org_9c1f0b7a2e3d4c5b",
  "object": "organization",
  "name": "Hof Meier",
  "slug": "hof-meier",
  "instance_url": "https://hof-meier.ladehase.com",
  "test_mode": true,
  "vat_registered": true,
  "vat_number": "string",
  "vat_rate_bps": 0,
  "accent_color": "string"
}

Organisation ändern

patch/v1/organization

Ändert Name, Subdomain (alte Subdomain bleibt als Weiterleitung), Adresse, MWST, Akzentfarbe, Bedingungen für Fahrende oder Sichtbarkeit der Instanzseite.

Request

NameTypeDescription
nameoptionalstring
slugoptionalstring
legal_nameoptionalstring | null
streetoptionalstring | null
postal_codeoptionalstring | null
cityoptionalstring | null
countryoptionalstring
contact_emailoptionalstring | null
contact_phoneoptionalstring | null
websiteoptionalstring | null
vat_registeredoptionalboolean
vat_numberoptionalstring | null
vat_rate_bpsoptionalinteger
accent_coloroptionalstring | null
logo_urloptionalstring | null
welcome_textoptionalobject | null
driver_termsoptionalobject | null
public_pageoptionalobject
test_modeoptionalboolean

Response 200Organization

NameTypeDescription
idrequiredstringID mit Präfix «org_»
objectrequired"organization"
namerequiredstring
slugrequiredstringSubdomain der Instanz
instance_urlrequiredstring
test_moderequiredbooleanTestmodus mit simulierten Ladepunkten und Testzahlungen
vat_registeredrequiredboolean
vat_numberrequiredstring | null
vat_rate_bpsrequiredintegerMWST-Satz in Basispunkten (810 = 8.1 %)
accent_colorrequiredstring | null

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/organization \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","slug":"string","legal_name":"string","street":"string","postal_code":"string","city":"string","country":"string","contact_email":"person@example.ch","contact_phone":"string","website":"https://example.ch/webhooks/ladehase","vat_registered":true,"vat_number":"string","vat_rate_bps":0,"accent_color":"string","logo_url":"https://example.ch/webhooks/ladehase","welcome_text":{"de":"string","fr":"string","it":"string","en":"string"},"driver_terms":{"de":"string","fr":"string","it":"string","en":"string"},"public_page":{"showLocations":true,"showTariffs":true,"showMap":true,"showContact":true,"showOpeningHours":true},"test_mode":true}'
Response 200
{
  "id": "org_9c1f0b7a2e3d4c5b",
  "object": "organization",
  "name": "Hof Meier",
  "slug": "hof-meier",
  "instance_url": "https://hof-meier.ladehase.com",
  "test_mode": true,
  "vat_registered": true,
  "vat_number": "string",
  "vat_rate_bps": 0,
  "accent_color": "string"
}