Vai al contenuto
Riferimento API

Team

5 endpoint

Le descrizioni degli endpoint provengono direttamente dall'API e sono in tedesco.

Mitglieder

get/v1/members

Mitglieder und offene Einladungen.

Risposta 200Object

Errori possibili

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

Person einladen

post/v1/invitations

Rollen: owner, admin, member.

Parametri

NomePosizioneTipo
idempotency-keyfacoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Intestazionestring

Richiesta

NomeTipoDescrizione
emailobbligatoriostring (email)
rolefacoltativo"owner" | "admin" | "member"

Risposta 201Object

Errori possibili

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Esempio
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"}'
Risposta 201
{}

Einladung zurückziehen

delete/v1/invitations/{id}

Der Link wird ungültig.

Parametri

NomePosizioneTipo
idobbligatorioPercorsostring

Risposta 200Deleted

NomeTipoDescrizione
idobbligatoriostring
objectobbligatoriostring
deletedobbligatoriotrue

Errori possibili

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

Rolle ändern

patch/v1/members/{id}

Mindestens eine Inhaberin oder ein Inhaber bleibt.

Parametri

NomePosizioneTipo
idobbligatorioPercorsostring

Richiesta

NomeTipoDescrizione
roleobbligatorio"owner" | "admin" | "member"

Risposta 200Object

Errori possibili

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Esempio
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"}'
Risposta 200
{}

Mitglied entfernen

delete/v1/members/{id}

Entfernt die Person aus der Organisation.

Parametri

NomePosizioneTipo
idobbligatorioPercorsostring

Risposta 200Deleted

NomeTipoDescrizione
idobbligatoriostring
objectobbligatoriostring
deletedobbligatoriotrue

Errori possibili

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