Se connecterCommencer gratuitement
Référence APILister les membres d'une salle
GET/v1/rooms/{id}/members

Lister les membres d'une salle

Renvoie la liste des membres (invités et collaborateurs) d'une salle de partage donnée.

1 min de lectureTélécharger en PDF

Réponse exemple

{
  "data": [
    {
      "role": "owner",
      "email": "owner@acme.com",
      "user_id": "8f3c1a92-4d77-4b0e-9a2f-1e6b2c7d8a01",
      "last_active_at": "2026-06-04T14:22:08.000Z"
    },
    {
      "role": "viewer",
      "email": "avocat@cabinet-durand.fr",
      "user_id": null,
      "last_active_at": null
    }
  ],
  "object": "list"
}
GET/v1/rooms/{id}/membersListe les membres rattachés à une salle de partage.

Renvoie l'ensemble des membres d'une salle de partage (room) identifiée par son id. Avant toute lecture, l'endpoint vérifie que la salle appartient bien à l'espace de travail (workspace) du jeton appelant : une salle d'un autre espace renvoie systématiquement un 404, jamais la liste. Les membres sont triés par role de façon décroissante, de sorte que les rôles à privilèges plus élevés remontent en premier. Cet endpoint est en lecture seule et n'est pas soumis au mécanisme d'idempotence.

Authentification

Requiert une clé API valide disposant du scope rooms:read. Un jeton porteur d'un scope plus large (par exemple rooms:* ou *) satisfait également cette exigence via la hiérarchie de scopes. En l'absence du scope, l'appel échoue avec un 403 scope_missing.

Paramètres de requête

ChampTypeRequisDescription
idstringOuiIdentifiant de la salle, fourni dans le chemin de l'URL (/v1/rooms/{id}/members).

Réponse

La réponse est un objet de type liste : object vaut "list" et data contient un tableau de membres. Chaque membre expose user_id (nul tant que l'invité n'a pas créé de compte), email, role et last_active_at (horodatage de dernière activité, nul si le membre n'a jamais ouvert la salle). Si la salle n'a aucun membre, data est un tableau vide.

Erreurs

CodeQuandRésolution
401 invalid_api_keyClé API absente, malformée ou non reconnue.Vérifiez l'en-tête Authorization: Bearer cof_live_... et la validité de la clé.
403 scope_missingLe jeton ne porte pas le scope rooms:read.Régénérez une clé incluant rooms:read (ou un scope englobant).
404 not_foundAucune salle avec cet id dans l'espace de travail du jeton.Vérifiez l'id de la salle et que la clé appartient au bon espace de travail.
429 rate_limitedQuota de requêtes en lecture par minute dépassé.Respectez l'en-tête Retry-After et lissez vos appels.
500 internal_errorErreur lors de la lecture en base.Réessayez ; si le problème persiste, contactez le support avec le X-Request-Id.

Voir aussi