Basis-URL:
/api/v1
Zum Dashboard

API-Dokumentation

Öffentliche / Benutzer-API-Endpunkte unter /api/v1. Einige Endpunkte erfordern Authentifizierung oder einen API-Schlüssel.

Authentifizierung

Fügen Sie Ihren API-Schlüssel in die Anfrage ein:

  • Authorization header: Authorization: Bearer <API_KEY>
  • Or header: X-API-Key: <API_KEY>
  • Or query: ?api_key=<API_KEY> (not recommended)

Tipp: Fordern Sie einen API-Schlüssel von Ihrem Administrator an oder verwalten Sie Ihre Schlüssel über das Dashboard.

Meine Organisationen

GET
/api/v1/organizations/my

Organisationen auflisten, zu denen der aktuelle Benutzer gehört.

GET
/api/v1/organizations/{organization}

Details für eine Organisation abrufen, zu der der Benutzer gehört.

POST
/api/v1/organizations

Neue Organisation erstellen (Benutzer wird Eigentümer).

PUT/PATCH
/api/v1/organizations/{organization}

Organisation aktualisieren, die Sie besitzen oder für die Sie Berechtigungen haben.

DELETE
/api/v1/organizations/{organization}

Organisation löschen, die Sie besitzen.

Teams

GET
/api/v1/organizations/{organization}/teams

Teams in einer Organisation auflisten, zu der Sie gehören.

GET
/api/v1/organizations/{organization}/teams/{team}

Team nach ID abrufen.

POST
/api/v1/organizations/{organization}/teams

Team innerhalb einer von Ihnen verwalteten Organisation erstellen.

PUT/PATCH
/api/v1/organizations/{organization}/teams/{team}

Team-Details aktualisieren.

DELETE
/api/v1/organizations/{organization}/teams/{team}

Team löschen.

Rollen

GET
/api/v1/organizations/{organization}/roles

In der Organisation verfügbare Rollen auflisten.

POST
/api/v1/organizations/{organization}/roles/{user}

Rolle eines Benutzers innerhalb einer Organisation zuweisen oder aktualisieren.

Partner

GET
/api/v1/affiliate

Partner-Informationen und -Statistiken des aktuellen Benutzers abrufen.

GET
/api/v1/affiliate/referrals

Empfehlungen und Verdienste auflisten.

POST
/api/v1/affiliate/withdraw

Partner-Auszahlung/Abhebung anfordern.

Profil

GET
/api/v1/profile

Profildaten des aktuellen Benutzers abrufen.

PUT/PATCH
/api/v1/profile

Ihre Profilinformationen aktualisieren (Name, Avatar, Einstellungen).

POST
/api/v1/profile/password

Ihr Kontopasswort ändern.

Abonnements

GET
/api/v1/subscriptions

Abonnements auflisten. Abfrage: search, per_page.

GET
/api/v1/subscriptions/{subscription}

Abonnement nach ID abrufen.

POST
/api/v1/subscriptions

Abonnement erstellen.

PUT/PATCH
/api/v1/subscriptions/{subscription}

Abonnement aktualisieren.

DELETE
/api/v1/subscriptions/{subscription}

Abonnement löschen.

Zahlungen

GET
/api/v1/payments

Zahlungen auflisten. Abfrage: search, per_page.

GET
/api/v1/payments/{payment}

Zahlung nach ID abrufen.

POST
/api/v1/payments

Zahlung erstellen.

PUT/PATCH
/api/v1/payments/{payment}

Zahlung aktualisieren.

DELETE
/api/v1/payments/{payment}

Zahlung löschen.