Ctrlk
WebsitePlatform

Benutzerverwaltung

Allgemeine Benutzerverwaltung

Abrufen einer paginierten Benutzerliste

get

Abrufen einer paginierten Benutzerliste

Dieser Endpunkt ermöglicht es einem Administrator, eine paginierte Liste von Benutzern unter seinem Konto abzurufen. Die Antwort enthält detaillierte Informationen für jeden Benutzer wie persönliche Attribute, Kontaktdaten und Metadaten im Zusammenhang mit ihrem Konto. Anwendungsbeispiel: Senden Sie eine GET-Anfrage an client-management/clients/ mit dem entsprechenden API-KEY-Token im Authorization-Header. Antwortstruktur:

  • users (array): Eine Liste von Benutzerobjekten, wobei jedes Objekt die folgenden Felder enthält:

    • created_at (string, date-time): Zeitstempel der Benutzererstellung.

    • weight (number): Das Gewicht des Benutzers.

    • age (string): Das Alter des Benutzers.

    • ycom (number): Der YCOM-Wert des Benutzers.

    • height (number): Die Größe des Benutzers.

    • phone (string): Die Telefonnummer des Benutzers.

    • leg_length (number): Die Beinlänge des Benutzers.

    • display_name (string): Der Anzeigename des Benutzers.

    • shoeSize (string): Die Schuhgröße des Benutzers.

    • email (string): Die E-Mail-Adresse des Benutzers.

    • gender (string): Das Geschlecht des Benutzers.

    • brand (string): Die mit dem Benutzer verbundene Marke.

    • shoeModel (string): Das Modell des Schuhs des Benutzers.

    • user_uid (string): Der eindeutige Identifikator des Benutzers.

Hinweise:

  • Ein gültiger API-KEY-Token ist erforderlich, um auf diesen Endpunkt zuzugreifen.

  • Falls keine Benutzer vorhanden sind oder ein Fehler auftritt, wird eine entsprechende Fehlermeldung zurückgegeben.

Autorisierungen
AuthorizationstringErforderlich

Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer

Antworten
200

Die Benutzerliste wurde erfolgreich abgerufen.

application/json
get
/client-management/clients/

Einen neuen Benutzer erstellen

post

Einen neuen Benutzer erstellen

Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, einen neuen Benutzer unter seinem Konto zu erstellen. Der Administrator muss die E-Mail-Adresse und den Anzeigenamen des Benutzers angeben und kann optional weitere Felder hinzufügen. Anwendungsbeispiel: Senden Sie eine POST-Anfrage an /clients/ mit einer JSON-Nutzlast, die die erforderlichen Felder enthält. Ein gültiger API-KEY-Token muss im Authorization-Header enthalten sein.

Anfrageparameter

  • display_name (string)

  • email (string, gültige E-Mail)

  • age (integer)

  • gender (male | female)

  • shoeSize (float)

  • weight (float)

  • height (float) Antwortstruktur: Bei Erfolg (HTTP 201) gibt der Endpunkt ein JSON-Objekt mit einem userData-Feld zurück, das die folgenden Schlüssel und Datentypen enthält:

  • user_uid (string): Ein eindeutiger Identifikator für den neu erstellten Benutzer.

  • display_name (string)

  • email (string, gültige E-Mail)

  • age (integer)

  • gender (male | female)

  • shoeSize (float)

  • weight (float)

  • height (float)

  • profile_photo (file, JPEG/PNG) - optionales Bild; nur verfügbar mit multipart/form-data.

Im Fehlerfall (z.B. fehlende Parameter, nicht autorisierter Zugriff oder ein interner Fehler) wird ein JSON-Objekt mit einem error-Feld (string) zurückgegeben.

Autorisierungen
AuthorizationstringErforderlich

Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer

Body
display_namestringErforderlich
emailstringErforderlich
ageintegerErforderlich
genderstringErforderlich
shoeSizenumberErforderlich
weightnumberErforderlich
heightnumberErforderlich
preferable_activitiesstringOptional

Optionale JSON-kodierte Liste bevorzugter Aktivitätstypen. Erlaubte Werte: 'Running', 'Vertical Jump', 'Weightlifting', 'Mobility Assessment'. Beispiel: ["Running", "Weightlifting"]

profile_photostringOptional

Optionales JPEG/PNG-Bild.

Antworten
post
/client-management/clients/

Einen Benutzer löschen

delete

Einen Benutzer löschen

Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, einen Benutzer aus seinem Konto zu löschen. Der Administrator muss den eindeutigen Identifikator des zu löschenden Benutzers im Anfragekörper angeben. Anfragekörper:

  • user_uid (string, erforderlich): Der eindeutige Identifikator des zu löschenden Benutzers. Antwortstruktur: Bei Erfolg (HTTP 200) gibt der Endpunkt ein JSON-Objekt mit einem message-Feld vom Typ string zurück, das die Löschung bestätigt. Im Fehlerfall (z.B. wenn die Benutzer-UID fehlt, der Benutzer nicht gefunden wird oder ein interner Fehler auftritt) wird ein JSON-Objekt mit einem error-Feld (string) zurückgegeben.

Autorisierungen
AuthorizationstringErforderlich

Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer

Abfrageparameter
user_uidstringErforderlich

UID des zu löschenden Benutzers

Antworten
200

Benutzer erfolgreich gelöscht.

application/json
messagestringOptional

Bestätigungsmeldung, die anzeigt, dass der Benutzer gelöscht wurde.

delete
/client-management/clients/

Benutzerinformationen aktualisieren

put

Benutzerinformationen aktualisieren

Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, ausgewählte Felder eines bestehenden Benutzers mit Query-String-Parametern zu aktualisieren. Erforderlicher Query-Parameter

  • user_uid (string) - die UID des zu aktualisierenden Benutzers. Optionale Query-Parameter - geben Sie einen oder mehrere der folgenden an:

  • display_name (string) - neuer Anzeigename

  • email (string, gültige E-Mail) - neue E-Mail-Adresse

  • age (integer)

  • gender (string, einer von male, female)

  • shoeSize (float)

  • weight (float)

  • height (float) Antwort (HTTP 200) json { "message": "Benutzerinformationen erfolgreich aktualisiert." } Wenn die Validierung fehlschlägt oder der Benutzer nicht gefunden wird, enthält die Antwort ein error-Feld mit Details.

Autorisierungen
AuthorizationstringErforderlich

Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer

Body
user_uidstringErforderlich
display_namestringOptional
emailstringOptional
ageintegerOptional
genderstringOptional
shoeSizenumberOptional
weightnumberOptional
heightnumberOptional
preferable_activitiesstringOptional

Optionale JSON-kodierte Liste bevorzugter Aktivitätstypen. Erlaubte Werte: 'Running', 'Vertical Jump', 'Weightlifting', 'Mobility Assessment'. Beispiel: ["Running", "Weightlifting"]

profile_photostringOptional

Optionales JPEG/PNG-Bild.

Antworten
200

Benutzerinformationen erfolgreich aktualisiert.

application/json
messagestringOptional

Bestätigungsmeldung, die die erfolgreiche Aktualisierung anzeigt.

put
/client-management/clients/

Benutzer filtern und paginieren

get

Benutzer filtern und paginieren

Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, die Benutzer unter seinem Konto zu filtern und zu paginieren. Sie können optional Query-Parameter angeben, um die Paginierung zu steuern:

  • start_after_id (string, optional): Die UID, nach der mit dem Abrufen von Benutzern begonnen werden soll (für Vorwärtspaginierung).

  • limit (integer, optional): Die maximale Anzahl der abzurufenden Benutzer. Standardmäßig 5, falls nicht angegeben.

Sie können Benutzer auch nach verschiedenen Kriterien filtern, wie z.B.:

  • admin_uid (string, optional): Die UID des Administrators, nach der Benutzer gefiltert werden sollen.

  • start_date (string, optional): Untere Grenze (inklusive) für die letzte Sitzung des Benutzers im Format YYYY-MM-DD.

  • end_date (string, optional): Obere Grenze (inklusive) für die letzte Sitzung des Benutzers im Format YYYY-MM-DD.

  • gender (string, optional): Filter nach Geschlecht (male oder female).

  • preferable_activities (array, optional): Filter nach bevorzugten Aktivitäten des Benutzers.

Antwortstruktur (HTTP 200): Die Antwort gibt ein JSON-Objekt mit den folgenden Feldern zurück:

  • query_count (integer): Gesamtanzahl der Benutzer unter dem Administrator.

  • users (array): Ein Array von Benutzerobjekten. Jedes Benutzerobjekt enthält:

    • created_at (string, date-time): Zeitstempel der Benutzererstellung.

    • weight (number): Das Gewicht des Benutzers.

    • age (string): Das Alter des Benutzers.

    • ycom (number): Der YCOM-Wert des Benutzers.

    • height (number): Die Größe des Benutzers.

    • phone (string): Die Telefonnummer des Benutzers.

    • leg_length (number): Die Beinlänge des Benutzers.

    • display_name (string): Der Anzeigename des Benutzers.

    • shoeSize (string): Die Schuhgröße des Benutzers.

    • email (string): Die E-Mail-Adresse des Benutzers.

    • gender (string): Das Geschlecht des Benutzers.

    • brand (string): Die mit dem Benutzer verbundene Marke.

    • shoeModel (string): Das Modell des Schuhs des Benutzers.

    • user_uid (string): Der eindeutige Identifikator des Benutzers.

  • first_uid (string): Die UID des ersten Benutzers auf der aktuellen Seite.

  • last_uid (string): Die UID des letzten Benutzers auf der aktuellen Seite. Hinweise:

  • Ein gültiger API-KEY-Token ist erforderlich.

  • Wenn keine Benutzer gefunden werden, wird eine Fehlermeldung mit Statuscode 404 zurückgegeben.

Autorisierungen
AuthorizationstringErforderlich

Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer

Abfrageparameter
admin_uidstringOptional

UID des Administrators (der den Benutzer erstellt hat), nach der Benutzer gefiltert werden sollen.

start_datestringOptional

Untere Grenze (inklusive) für last_session im Format YYYY-MM-DD.

end_datestringOptional

Obere Grenze (inklusive) für last_session im Format YYYY-MM-DD.

genderstring · enumOptional

Filter nach Geschlecht (male oder female).

Mögliche Werte:
preferable_activitiesstringOptional

JSON-Array bevorzugter Aktivitäten.

start_after_idstringOptional
limitintegerOptional
Antworten
200

Die gefilterte Benutzerliste wurde erfolgreich abgerufen.

application/json
query_countintegerErforderlich

Gesamtanzahl der Benutzer unter dem Administrator.

first_uidstringErforderlich

UID des ersten Benutzers auf der aktuellen Seite.

last_uidstringErforderlich

UID des letzten Benutzers auf der aktuellen Seite.

get
/client-management/clients/filter/

Eine Notiz für einen Client setzen/ersetzen

post

Speichert eine Notiz pro Client. Falls note weggelassen oder leer ist, wird die vorherige Notiz gelöscht (als null gespeichert). Dokumentenstruktur:

  "text": "Hamstring strain - reduce speed work for 2 wks",  // oder null
  "updated_at": "2025-07-14T09:32:11.123Z"
} ```
Autorisierungen
AuthorizationstringErforderlich

Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer

Pfadparameter
user_uidanyErforderlich
Body
notestringErforderlich

Freiform-Notiztext (≤ 100 kB). Falls weggelassen oder leer, wird die Notiz gelöscht.

Antworten
200

Notiz erfolgreich gespeichert/ersetzt.

application/json
messagestringErforderlich
post
/client-management/clients/save-notes/{user_uid}

Details für einen bestimmten Benutzer abrufen

get

Benutzerdetails abrufen

Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, detaillierte Informationen für einen bestimmten Benutzer unter seinem Konto abzurufen. Der Benutzer wird durch den eindeutigen user_uid-Parameter in der URL identifiziert. Pfadparameter:

  • user_uid (string, erforderlich): Der eindeutige Identifikator des Benutzers. Antwortstruktur (HTTP 200): Gibt ein JSON-Objekt mit den folgenden Feldern und Datentypen zurück:

  • created_at (string, date-time): Zeitstempel der Benutzererstellung.

  • weight (number): Das Gewicht des Benutzers.

  • age (string): Das Alter des Benutzers.

  • ycom (number): Der YCOM-Wert des Benutzers.

  • height (number): Die Größe des Benutzers.

  • phone (string): Die Telefonnummer des Benutzers.

  • leg_length (number): Die Beinlänge des Benutzers.

  • display_name (string): Der Anzeigename des Benutzers.

  • shoeSize (string): Die Schuhgröße des Benutzers.

  • email (string): Die E-Mail-Adresse des Benutzers.

  • gender (string): Das Geschlecht des Benutzers.

  • brand (string): Die mit dem Benutzer verbundene Marke.

  • shoeModel (string): Das Modell des Schuhs des Benutzers.

  • user_uid (string): Der eindeutige Identifikator des Benutzers. Beispiel für eine erfolgreiche Antwort:

Autorisierungen
AuthorizationstringErforderlich

Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer

Pfadparameter
user_uidanyErforderlich
Antworten
200

Benutzerdetails erfolgreich abgerufen.

application/json
created_atstring · date-timeErforderlich

Zeitstempel der Benutzererstellung.

weightnumberErforderlich

Das Gewicht des Benutzers.

agestringErforderlich

Das Alter des Benutzers.

ycomnumberErforderlich

Der YCOM-Wert des Benutzers.

heightnumberErforderlich

Die Größe des Benutzers.

phonestringErforderlich

Die Telefonnummer des Benutzers.

leg_lengthnumberErforderlich

Die Beinlänge des Benutzers.

display_namestringErforderlich

Der Anzeigename des Benutzers.

shoeSizestringErforderlich

Die Schuhgröße des Benutzers.

emailstring · emailErforderlich

Die E-Mail-Adresse des Benutzers.

genderstringErforderlich

Das Geschlecht des Benutzers.

brandstringErforderlich

Die mit dem Benutzer verbundene Marke.

shoeModelstringErforderlich

Das Modell des Schuhs des Benutzers.

profile_photostring · uriOptional

Öffentliche URL des Profilfotos.

user_uidstringErforderlich

Der eindeutige Identifikator des Benutzers.

get
/client-management/clients/{user_uid}
VorherigeAPI-ReferenzNächsteVerwaltung aller Sitzungen

Zuletzt aktualisiert

War das hilfreich?