Team

5 endpoints

Les descriptions des endpoints proviennent directement de l'API et sont en allemand.

Mitglieder

get/v1/members

Mitglieder und offene Einladungen.

Réponse 200Object

Erreurs possibles

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Exemple

curl -X GET https://api.ladehase.com/v1/members \n  -H "Authorization: Bearer lh_test_…"

Réponse 200

{}

Person einladen

post/v1/invitations

Rollen: owner, admin, member.

Paramètres

Nom	Emplacement	Type
`idempotency-key`facultatifWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	En-tête	string

Requête

Nom	Type	Description
`email`obligatoire	string (email)
`role`facultatif	"owner" \| "admin" \| "member"

Réponse 201Object

Erreurs possibles

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Exemple

curl -X POST https://api.ladehase.com/v1/invitations \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"email":"person@example.ch","role":"member"}'

Réponse 201

{}

Einladung zurückziehen

delete/v1/invitations/{id}

Der Link wird ungültig.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Réponse 200Deleted

Nom	Type	Description
`id`obligatoire	string
`object`obligatoire	string
`deleted`obligatoire	true

Erreurs possibles

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Exemple

curl -X DELETE https://api.ladehase.com/v1/invitations/{id} \n  -H "Authorization: Bearer lh_test_…"

Réponse 200

{
  "id": "string",
  "object": "string",
  "deleted": true
}

Rolle ändern

patch/v1/members/{id}

Mindestens eine Inhaberin oder ein Inhaber bleibt.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Requête

Nom	Type	Description
`role`obligatoire	"owner" \| "admin" \| "member"

Réponse 200Object

Erreurs possibles

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Exemple

curl -X PATCH https://api.ladehase.com/v1/members/{id} \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"role":"owner"}'

Réponse 200

{}

Mitglied entfernen

delete/v1/members/{id}

Entfernt die Person aus der Organisation.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Réponse 200Deleted

Nom	Type	Description
`id`obligatoire	string
`object`obligatoire	string
`deleted`obligatoire	true

Erreurs possibles

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Exemple

curl -X DELETE https://api.ladehase.com/v1/members/{id} \n  -H "Authorization: Bearer lh_test_…"

Réponse 200

{
  "id": "string",
  "object": "string",
  "deleted": true
}