Chat-Mitglieder

Dieses Modul beschreibt die API-Endpunkte zur Verwaltung von Chat-Mitgliedern (chat_member) innerhalb eines Chats. Ein chat_member ist eine Teilmenge des allgemeinen user-Typs, speziell angepasst an die Anforderungen der Chat-Funktion. Die id eines chat_member ist gleichzeitig eine gültige Nutzer-ID (user).

---

Gültige Attribute

Attribut	Beschreibung	Details
discarded_at	Zeitpunkt der Entfernung (oder null)	Kann nicht manuell gesetzt werden.
email	E-Mail-Adresse des Benutzers	Optional. Falls gesetzt, eindeutig innerhalb eines Accounts.
name	Name des Benutzers	Frei wählbar.

---

Beziehungen

Folgende Beziehungen können mit dem Parameter include in den Request eingebunden werden:

Beziehung	Typ	Beschreibung
roles	has_many	Die Chat-spezifischen Rollen, die der Benutzer im jeweiligen Chat hat

---

Auflisten

Mit diesem Endpunkt kannst du alle Mitglieder eines bestimmten Chats abrufen. Optional kannst du verknüpfte Ressourcen wie Rollen über den include-Parameter einbinden.

---

Endpunkt

GET /api/v1/chats/:chat_id/members

---

Parameter

Name	Beschreibung
chat_id	Die ID des Chats, dessen Mitglieder du abrufen willst

---

Response

{
  "data": [
    {
      "id": "0e2eb81a-f952-4e8d-a6f8-9f757459a241",
      "type": "chat_member",
      "attributes": {
        ...
      }
    },
    {
      ...
    }
  ]
}

---

Beispiele

Chat-Mitglieder mit den Rollen, die sie im Chat haben:

GET /api/v1/chats/:chat_id/members?include=roles