API Liste des membres

Lister les membres d'une organisation avec une clé d'API.

Liste les membres de l'organisation à laquelle appartient la clé d'API. Une clé est rattachée à une seule organisation : aucun identifiant d'organisation n'est à transmettre.

Utilisez GET /api/v1/me pour obtenir l'identifiant, le nom ou le slug de l'organisation de la clé. Utilisez GET /api/v1/members/:memberId pour un membre précis.

Point d'entrée

GET /api/v1/members

Authentification

Créez une clé d'API depuis les réglages de l'organisation :

/orgs/{orgSlug}/settings/api-keys

Envoyez la clé dans l'en-tête x-api-key :

x-api-key: VOTRE_CLE_API

L'authentification par jeton porteur est également acceptée :

Authorization: Bearer VOTRE_CLE_API

Réponse

Champ	Type	Description
`members`	tableau	Membres de l'organisation de la clé
`count`	nombre	Nombre de membres dans cette page
`nextCursor`	chaîne \| null	Curseur de la page suivante
`hasMore`	booléen	Indique s'il reste une page à récupérer

Passez limit (1 à 100, 50 par défaut) et le nextCursor de la réponse précédente en paramètres d'URL pour parcourir une grande organisation.

Objet membre

Champ	Type	Description
`id`	chaîne	Identifiant de l'appartenance à l'organisation
`role`	chaîne	Rôle du membre, par exemple `owner`
`createdAt`	nombre	Date d'ajout, en millisecondes
`user.id`	chaîne	Identifiant de l'utilisateur
`user.name`	chaîne	Nom affiché
`user.email`	chaîne	Adresse électronique
`user.image`	chaîne \| null	URL de la photo

Exemples

cURL

curl -H "x-api-key: VOTRE_CLE_API" \
  https://chambree.fr/api/v1/members

JavaScript

const response = await fetch("https://chambree.fr/api/v1/members", {
  headers: {
    "x-api-key": process.env.CHAMBREE_API_KEY!,
  },
});

if (!response.ok) {
  throw new Error(`Appel /api/v1/members en échec : ${response.status}`);
}

const data = await response.json();

Erreurs

Statut	Description
`401`	Clé absente, invalide, expirée ou restreinte
`404`	L'organisation de la clé ou le membre demandé n'existe plus
`500`	Erreur interne du serveur